Skip to main content
Tools Reference

Autotask Tools

Written By Christopher Scaminaci

Last updated 7 days ago

Autotask Tools

at_ · 458 tools · Free 298 · Pro 160 Static API headers (ApiIntegrationCode/UserName/Secret); zone auto-discovery; cursor pagination via nextPageUrl; max page size 500.

All connector tools · Autotask setup guide

Autotask tool groups

Service Tickets

ToolPlanAccessSummary
at_count_ticketsFreeRead-onlyCount tickets matching optional filters.
at_create_ticketProDestructiveCreate a new service ticket.
at_get_ticketFreeRead-onlyRetrieve a single ticket by its numeric ID.
at_list_company_ticketsFreeRead-onlyList tickets for a specific company.
at_list_high_priority_ticketsFreeRead-onlyList open tickets with Critical (priority 1) or High (priority 2) priority.
at_list_open_ticketsFreeRead-onlyList open tickets (status is not Complete).
at_list_past_due_ticketsFreeRead-onlyList open tickets that are past their due date.
at_list_recently_updated_ticketsFreeRead-onlyList tickets updated within the last 24 hours.
at_list_resource_ticketsFreeRead-onlyList tickets assigned to a specific resource.
at_list_ticketsFreeRead-onlyQuery tickets with optional filters.
at_list_unassigned_ticketsFreeRead-onlyList open tickets with no assigned resource.
at_search_ticketsFreeRead-onlySearch tickets by title keyword.
at_update_ticketProDestructiveUpdate an existing ticket via PATCH.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID.
endDatestringnonullFilter by end date in yyyy-MM-dd format.
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries. When provided, typed filter params are ignored.
queueIdintegernonullFilter by queue ID.
resourceIdintegernonullFilter by assigned resource ID.
startDatestringnonullFilter by start date in yyyy-MM-dd format.
statusIdintegernonullFilter by status ID.

[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.

ParamTypeRequiredDefaultDescription
assignedResourceIdintegernonullResource ID to assign the ticket to (optional). Use at_list_resources to find valid IDs.
companyIdintegeryesCompany ID the ticket belongs to. Use at_list_companies to find valid IDs.
fieldsJsonstringnonullAdditional fields as JSON object (optional). Merged with the above parameters. Example: {"description":"Details here","dueDateTime":"2026-04-01"}
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.
priorityIdintegernonullPriority ID (optional). Use Autotask field info to find valid priority IDs.
queueIdintegernonullQueue ID (optional). Routes the ticket to a specific queue.
statusIdintegernonullStatus ID (optional). Use Autotask field info to find valid status IDs.
titlestringyesTicket title/subject line. Keep concise and descriptive.

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe numeric Autotask ticket ID. Use at_list_tickets or at_search_tickets to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe numeric Autotask company ID. Use at_list_companies to find valid IDs.
includeClosedbooleannofalseInclude closed/completed tickets (default false, shows only open).
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List open tickets that are past their due date. Useful for identifying overdue work items that need immediate attention.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List tickets updated within the last 24 hours. Useful for monitoring recent helpdesk activity without filtering by status or priority.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
resourceIdintegeryesThe numeric Autotask resource ID. Use at_list_resources to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID. Use at_list_companies to find valid IDs.
endDatestringnonullFilter by end date in yyyy-MM-dd format. Returns tickets created on or before this date.
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries. When provided, typed filter params are ignored. Example: [{"op":"eq","field":"status","value":1}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
queueIdintegernonullFilter by queue ID.
resourceIdintegernonullFilter by assigned resource ID. Use at_list_resources to find valid IDs.
startDatestringnonullFilter by start date in yyyy-MM-dd format. Returns tickets created on or after this date.
statusIdintegernonullFilter by status ID. Use at_list_ticket_statuses or Autotask field info to find valid status IDs.

[Autotask] List open tickets with no assigned resource. Useful for triage queues -- shows tickets waiting to be dispatched.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
searchstringyesSearch term to match against ticket titles. Case-insensitive contains match.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"status":2,"priority":3,"queueID":5}. Field names must match Autotask API field names.
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.
ticketIdintegeryesThe numeric Autotask ticket ID to update.

Ticket Notes and Checklists

ToolPlanAccessSummary
at_create_ticket_checklist_itemProWriteAdd a checklist item to an existing ticket.
at_create_ticket_noteProDestructiveAdd a note to an existing ticket.
at_get_ticket_noteFreeRead-onlyRetrieve a single ticket note by its numeric ID.
at_list_ticket_checklist_itemsFreeRead-onlyList checklist items for a specific ticket.
at_list_ticket_notesFreeRead-onlyList notes for a specific ticket.
at_update_ticket_checklist_itemProWriteUpdate an existing ticket checklist item via PATCH.
at_update_ticket_noteProDestructiveUpdate an existing ticket note via PATCH.

[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.

ParamTypeRequiredDefaultDescription
isCompletebooleannofalseWhether the item is already complete (default false).
itemNamestringyesName/description of the checklist item.
ticketIdintegeryesThe numeric Autotask ticket ID to add the checklist item to.

[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.

ParamTypeRequiredDefaultDescription
descriptionstringyesNote description/body text.
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.
noteTypestringno"Internal"Note type. Common values: 'Internal' (default), 'External', 'Resolution'. Controls visibility and categorization.
publishstringnonullPublish setting (optional). Controls visibility on customer portal. Common values: 'All', 'Internal Only'.
ticketIdintegeryesThe numeric Autotask ticket ID to add the note to.
titlestringyesNote title/subject line.

[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.

ParamTypeRequiredDefaultDescription
noteIdintegeryesThe numeric Autotask ticket note ID. Use at_list_ticket_notes to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegeryesThe numeric Autotask ticket ID to list checklist items for.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegeryesThe numeric Autotask ticket ID to list notes for.

[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.

ParamTypeRequiredDefaultDescription
checklistItemIdintegeryesThe numeric Autotask checklist item ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"isComplete":true} to mark complete, or {"itemName":"Updated name"}. Field names must match Autotask API field names.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"title":"Updated title","description":"Updated body","noteType":"External"}. Field names must match Autotask API field names.
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.
noteIdintegeryesThe numeric Autotask ticket note ID to update.

Ticket Charges

ToolPlanAccessSummary
at_create_ticket_chargeProDestructiveAdd a charge to an existing ticket.
at_get_ticket_chargeFreeRead-onlyRetrieve a single ticket charge by its numeric ID.
at_list_ticket_additional_contactsFreeRead-onlyList additional contacts associated with a ticket.
at_list_ticket_chargesFreeRead-onlyList charges on a specific ticket.
at_update_ticket_chargeProDestructiveUpdate an existing ticket charge via PATCH.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesCharge 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.
ticketIdintegeryesThe numeric Autotask ticket ID to add the charge to.

[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.

ParamTypeRequiredDefaultDescription
chargeIdintegeryesThe numeric Autotask ticket charge ID. Use at_list_ticket_charges to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegeryesThe numeric Autotask ticket ID to list additional contacts for.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegeryesThe numeric Autotask ticket ID to list charges for.

[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.

ParamTypeRequiredDefaultDescription
chargeIdintegeryesThe numeric Autotask ticket charge ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"unitQuantity":3.0,"unitCost":80.00}. Field names must match Autotask API field names.

Service Calls

ToolPlanAccessSummary
at_count_service_callsFreeRead-onlyCount service calls matching optional filters.
at_create_service_callProDestructiveCreate a new service call for dispatch/scheduling.
at_create_service_call_taskProDestructiveCreate a new task for a service call.
at_create_service_call_ticketProDestructiveLink an existing ticket to a service call.
at_delete_service_callProDestructiveDelete a service call by its numeric ID.
at_get_service_callFreeRead-onlyRetrieve a single service call by its numeric ID.
at_list_service_call_task_resourcesFreeRead-onlyQuery resources assigned to service call tasks.
at_list_service_call_tasksFreeRead-onlyQuery tasks associated with service calls.
at_list_service_call_ticketsFreeRead-onlyQuery tickets linked to service calls.
at_list_service_callsFreeRead-onlyQuery service calls with optional filters.
at_update_service_callProDestructiveUpdate an existing service call.

[Autotask] Count service calls matching optional filters. Returns the total number of matching service calls without fetching data.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Omit for no filtering.

[Autotask] Create a new service call for dispatch/scheduling. Returns the created service call with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the service call to create. Include required fields like companyID and description.

[Autotask] Create a new task for a service call. Returns the created task with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the service call task to create. Include serviceCallID and other required fields.

[Autotask] Link an existing ticket to a service call. Returns the created association record.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the service call ticket association. Include serviceCallID and ticketID.

[Autotask] Delete a service call by its numeric ID. This permanently removes the service call.

ParamTypeRequiredDefaultDescription
serviceCallIdintegeryesThe numeric Autotask service call ID to delete.

[Autotask] Retrieve a single service call by its numeric ID. Returns full service call details including status, scheduled times, and assignments.

ParamTypeRequiredDefaultDescription
serviceCallIdintegeryesThe numeric Autotask service call ID.

[Autotask] Query resources assigned to service call tasks. Returns resource assignment details. Use filterJson to narrow by service call task ID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"serviceCallTaskID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query tasks associated with service calls. Returns task details including assignments and status. Use filterJson to narrow by service call ID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
serviceCallIdintegernonullFilter by service call ID.

[Autotask] Query tickets linked to service calls. Returns ticket associations. Use filterJson to narrow by service call ID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
serviceCallIdintegernonullFilter by service call ID.

[Autotask] Query service calls with optional filters. Returns paginated service call summaries used for dispatch and scheduling. Use filterJson for advanced queries.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"status","value":1}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing service call. The id field is automatically included. Returns the updated service call.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"status":2,"description":"Updated"}.
serviceCallIdintegeryesThe numeric Autotask service call ID to update.

Ticket Sub-Resources

ToolPlanAccessSummary
at_create_ticket_additional_ciProWriteLink an additional configuration item to a ticket.
at_create_ticket_change_request_approvalProDestructiveCreate a change request approval for a ticket.
at_create_ticket_rma_creditProDestructiveCreate an RMA credit for a ticket.
at_create_ticket_secondary_resourceProWriteAssign a secondary resource to a ticket.
at_create_ticket_tag_associationProWriteAssociate a tag with a ticket.
at_delete_ticket_additional_ciProDestructiveRemove an additional configuration item link from a ticket by its association ID.
at_delete_ticket_secondary_resourceProDestructiveRemove a secondary resource assignment from a ticket by its assignment ID.
at_delete_ticket_tag_associationProDestructiveRemove a tag association from a ticket by its association ID.
at_get_ticket_note_attachmentFreeRead-onlyRetrieve a single ticket note attachment by its numeric ID.
at_list_ticket_additional_cisFreeRead-onlyQuery additional configuration items linked to tickets.
at_list_ticket_change_request_approvalsFreeRead-onlyQuery change request approvals for tickets.
at_list_ticket_historyFreeRead-onlyQuery the audit history for tickets.
at_list_ticket_note_attachmentsFreeRead-onlyQuery attachments on ticket notes.
at_list_ticket_rma_creditsFreeRead-onlyQuery RMA credits associated with tickets.
at_list_ticket_secondary_resourcesFreeRead-onlyQuery secondary resources assigned to tickets.
at_list_ticket_tag_associationsFreeRead-onlyQuery tag associations for tickets.

[Autotask] Link an additional configuration item to a ticket. Returns the created association record. Include ticketID and configurationItemID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the additional CI link. Include ticketID and configurationItemID.

[Autotask] Create a change request approval for a ticket. Returns the created approval record.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the change request approval. Include ticketID and approval details.

[Autotask] Create an RMA credit for a ticket. Returns the created RMA credit record.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the RMA credit. Include ticketID and credit details.

[Autotask] Assign a secondary resource to a ticket. Returns the created assignment record. Include ticketID and resourceID in the JSON.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the secondary resource assignment. Include ticketID and resourceID.

[Autotask] Associate a tag with a ticket. Returns the created tag association record. Include ticketID and tagID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the tag association. Include ticketID and tagID.
ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask ticket additional CI association ID to delete.
ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask ticket secondary resource assignment ID to delete.
ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask ticket tag association ID to delete.

[Autotask] Retrieve a single ticket note attachment by its numeric ID. Returns attachment metadata including filename and content type.

ParamTypeRequiredDefaultDescription
attachmentIdintegeryesThe numeric Autotask ticket note attachment ID.

[Autotask] Query additional configuration items linked to tickets. Filter by ticketID to see CIs for a specific ticket.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegernonullFilter by ticket ID.

[Autotask] Query change request approvals for tickets. Filter by ticketID to see approvals for a specific ticket.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegernonullFilter by ticket ID.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegernonullFilter by ticket ID.

[Autotask] Query attachments on ticket notes. Filter by noteID or ticketID to narrow results.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query RMA credits associated with tickets. Filter by ticketID to see credits for a specific ticket.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegernonullFilter by ticket ID.

[Autotask] Query secondary resources assigned to tickets. Returns resource assignment records. Filter by ticketID to see secondary resources for a specific ticket.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegernonullFilter by ticket ID.

[Autotask] Query tag associations for tickets. Filter by ticketID to see tags on a specific ticket.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegernonullFilter by ticket ID.

Companies

ToolPlanAccessSummary
at_count_companiesFreeRead-onlyGet total count of companies matching optional filters.
at_create_companyProWriteCreate a new company record.
at_get_companyFreeRead-onlyRetrieve full details for a single company by ID.
at_list_active_companiesFreeRead-onlyList companies that are currently active.
at_list_companiesFreeRead-onlyQuery companies with optional filters and pagination.
at_list_company_todosFreeRead-onlyList to-do items associated with a specific company.
at_list_customer_companiesFreeRead-onlyList companies of type Customer (companyType=1).
at_list_prospect_companiesFreeRead-onlyList companies of type Prospect (companyType=3).
at_search_companiesFreeRead-onlySearch companies by name.
at_update_companyProWriteUpdate an existing company's fields.

[Autotask] Get total count of companies matching optional filters. Returns a count object. Useful for pagination planning or dashboards.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the company to create. Must include companyName and companyType. Example: {"companyName":"Acme Corp","companyType":1,"phone":"555-0100"}.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID.

[Autotask] List companies that are currently active. Filters on isActive=true. Useful for client roster views and service reporting.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"companyType","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list to-dos for.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List companies of type Customer (companyType=1). Useful for client roster views, billing reviews, and service reporting.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List companies of type Prospect (companyType=3). Useful for sales pipeline reviews -- shows companies that are potential customers but not yet active clients.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against company name.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"companyName":"Acme Corp Updated","phone":"555-0200"}.

Company Sub-Resources

ToolPlanAccessSummary
at_create_company_locationProWriteAdd a new location to a company.
at_create_company_noteProDestructiveAdd a note to a company.
at_get_company_attachmentFreeRead-onlyRetrieve a single company attachment by its numeric ID.
at_get_company_locationFreeRead-onlyRetrieve full details for a single company location by ID.
at_get_company_site_configFreeRead-onlyRetrieve a single company site configuration by its numeric ID.
at_list_company_alertsFreeRead-onlyList alerts for a specific company.
at_list_company_attachmentsFreeRead-onlyList attachments for a specific company.
at_list_company_locationsFreeRead-onlyList locations for a specific company.
at_list_company_notesFreeRead-onlyList notes for a specific company.
at_list_company_site_configsFreeRead-onlyList site configurations for a specific company.
at_list_company_teamsFreeRead-onlyList teams assigned to a specific company.
at_update_company_locationProWriteUpdate an existing company location's fields.
at_update_company_site_configProWriteUpdate an existing company site configuration.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to add the location to.
fieldsJsonstringyesJSON object for the location to create. Example: {"name":"Main Office","address1":"123 Main St","city":"Denver","state":"CO","postalCode":"80202"}.

[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).

ParamTypeRequiredDefaultDescription
actionTypeintegernonullAction 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.
assignedResourceIDintegernonullAssigned 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.
companyIdintegeryesThe Autotask company ID to add the note to.
descriptionstringyesThe note description/body text.
endDateTimestringnonullNote 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).
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.
startDateTimestringnonullNote 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).
titlestringyesThe note title.

[Autotask] Retrieve a single company attachment by its numeric ID. Returns attachment metadata including filename, size, and content type.

ParamTypeRequiredDefaultDescription
attachmentIdintegeryesThe numeric Autotask company attachment ID.

[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.

ParamTypeRequiredDefaultDescription
locationIdintegeryesThe Autotask company location ID.

[Autotask] Retrieve a single company site configuration by its numeric ID. Returns full configuration details.

ParamTypeRequiredDefaultDescription
configIdintegeryesThe numeric Autotask company site configuration ID.

[Autotask] List alerts for a specific company. Returns alert details including type, severity, and message. Requires a valid company ID.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list alerts for.
nextPageUrlstringnonullPagination 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).

[Autotask] List attachments for a specific company. Returns attachment metadata including filename, size, and content type. Filter by parentID (company ID).

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list attachments for.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list locations for.
nextPageUrlstringnonullPagination 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).

[Autotask] List notes for a specific company. Returns note details including title, description, and timestamps. Requires a valid company ID.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list notes for.
nextPageUrlstringnonullPagination 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).

[Autotask] List site configurations for a specific company. Returns configuration details for company sites. Filter by companyID.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list site configurations for.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List teams assigned to a specific company. Returns team details including resource assignments. Requires a valid company ID.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list teams for.
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing company location's fields. Returns the updated location. Use at_get_company_location to check current values before updating.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"name":"Branch Office","phone":"555-0300"}.
locationIdintegeryesThe Autotask company location ID to update.

[Autotask] Update an existing company site configuration. The id field is automatically included. Returns the updated configuration.

ParamTypeRequiredDefaultDescription
configIdintegeryesThe numeric Autotask company site configuration ID to update.
fieldsJsonstringyesJSON object with fields to update.

Contacts

ToolPlanAccessSummary
at_count_contactsFreeRead-onlyGet total count of contacts matching optional filters.
at_create_contactProWriteCreate a new contact record.
at_create_contact_billing_productProDestructiveCreate a billing product association for a contact.
at_create_contact_groupProWriteCreate a new contact group.
at_create_contact_group_contactProWriteAdd a contact to a contact group.
at_delete_contact_billing_productProDestructiveDelete a contact billing product association by ID.
at_delete_contact_groupProDestructiveDelete a contact group by its numeric ID.
at_get_contactFreeRead-onlyRetrieve full details for a single contact by ID.
at_list_company_contactsFreeRead-onlyList contacts belonging to a specific company.
at_list_contact_billing_productsFreeRead-onlyQuery billing product associations for contacts.
at_list_contact_group_contactsFreeRead-onlyList contacts belonging to a specific contact group.
at_list_contact_groupsFreeRead-onlyList contact groups with optional filters.
at_list_contactsFreeRead-onlyQuery contacts with optional filters and pagination.
at_search_contactsFreeRead-onlySearch contacts by name or email address.
at_update_client_portal_userProDestructiveUpdate a client portal user's settings.
at_update_contactProWriteUpdate an existing contact's fields.
at_update_contact_groupProWriteUpdate an existing contact group.

[Autotask] Get total count of contacts matching optional filters. Returns a count object. Useful for pagination planning or dashboards.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":1}]. Omit for no filtering.

[Autotask] Create a new contact record. Returns the created contact with its assigned ID. The JSON should include at minimum firstName, lastName, and companyID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the contact to create. Example: {"firstName":"Jane","lastName":"Doe","companyID":12345,"emailAddress":"jane@example.com"}.
ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with billing product association fields.

[Autotask] Create a new contact group. Returns the created group with its assigned ID. Include at minimum a name field.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the contact group to create. Example: {"name":"VIP Contacts","isActive":true}.

[Autotask] Add a contact to a contact group. Returns the created membership record. Include contactGroupID and contactID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the group membership. Include contactGroupID and contactID.
ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask contact billing product association ID.

[Autotask] Delete a contact group by its numeric ID. This permanently removes the group.

ParamTypeRequiredDefaultDescription
groupIdintegeryesThe numeric Autotask contact group ID to delete.

[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.

ParamTypeRequiredDefaultDescription
contactIdintegeryesThe Autotask contact ID.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list contacts for.
nextPageUrlstringnonullPagination 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).

[Autotask] Query billing product associations for contacts. Returns products linked to contacts for billing purposes.

ParamTypeRequiredDefaultDescription
contactIdintegernonullFilter by contact ID.
filterJsonstringnonullRaw Autotask filter JSON array.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List contacts belonging to a specific contact group. Filter by contactGroupID to see members.

ParamTypeRequiredDefaultDescription
groupIdintegeryesThe Autotask contact group ID to list contacts for.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List contact groups with optional filters. Returns group details including name and description. Useful for organizing contacts into categories.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against first name, last name, or email address.
ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with client portal user fields to update. Must include id.

[Autotask] Update an existing contact's fields. Returns the updated contact. Use at_get_contact to check current values before updating.

ParamTypeRequiredDefaultDescription
contactIdintegeryesThe Autotask contact ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"emailAddress":"new@example.com","phone":"555-0200"}.

[Autotask] Update an existing contact group. The id field is automatically included. Returns the updated group.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"name":"Updated Group Name"}.
groupIdintegeryesThe Autotask contact group ID to update.

Configuration Items (Assets)

ToolPlanAccessSummary
at_count_configuration_itemsFreeRead-onlyGet total count of configuration items matching optional filters.
at_create_ci_noteProDestructiveAdd a note to a configuration item.
at_create_configuration_itemProWriteCreate a new configuration item (asset) record.
at_get_configuration_itemFreeRead-onlyRetrieve full details for a single configuration item (asset) by ID.
at_list_active_configuration_itemsFreeRead-onlyList configuration items that are currently active.
at_list_ci_notesFreeRead-onlyList notes associated with a specific configuration item.
at_list_company_configuration_itemsFreeRead-onlyList all configuration items (assets) for a specific company.
at_list_configuration_itemsFreeRead-onlyQuery configuration items (assets) with optional filters and pagination.
at_search_configuration_itemsFreeRead-onlySearch configuration items by title, serial number, or reference number.
at_update_configuration_itemProWriteUpdate an existing configuration item's fields.

[Autotask] Get total count of configuration items matching optional filters. Returns a count object. Useful for pagination planning or asset inventory dashboards.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.

[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.

ParamTypeRequiredDefaultDescription
configItemIdintegeryesThe Autotask configuration item ID to add the note to.
descriptionstringyesDescription/body of the note.
titlestringyesTitle of the note.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the CI to create. Must include referenceTitle and companyID. Example: {"referenceTitle":"DESKTOP-001","companyID":123,"configurationItemType":5,"serialNumber":"SN12345"}.

[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.

ParamTypeRequiredDefaultDescription
configItemIdintegeryesThe Autotask configuration item ID.

[Autotask] List configuration items that are currently active. Filters on isActive=true. Useful for current asset inventory views, excluding retired or decommissioned equipment.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List notes associated with a specific configuration item. Returns note details including title, description, and created date. Requires a valid CI ID.

ParamTypeRequiredDefaultDescription
configItemIdintegeryesThe Autotask configuration item ID to list notes for.
nextPageUrlstringnonullPagination 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).

[Autotask] List all configuration items (assets) for a specific company. Filters CIs by companyID. Useful for asset inventory reviews or pre-ticket context gathering.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list CIs for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"companyID","value":123}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against CI referenceTitle.

[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.

ParamTypeRequiredDefaultDescription
configItemIdintegeryesThe Autotask configuration item ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"referenceTitle":"DESKTOP-002","serialNumber":"SN67890"}.

CI Sub-Resources

ToolPlanAccessSummary
at_list_ci_categoriesFreeRead-onlyList configuration item categories with optional filters.
at_list_ci_category_udf_associationsFreeRead-onlyList user-defined field (UDF) associations for a specific configuration item category.
at_list_ci_dns_recordsFreeRead-onlyList DNS records associated with a configuration item.
at_list_ci_related_itemsFreeRead-onlyList items related to a configuration item.
at_list_ci_ssl_certificatesFreeRead-onlyList SSL certificates associated with a configuration item.
at_list_ci_typesFreeRead-onlyList configuration item types with optional filters.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
categoryIdintegeryesThe Autotask CI category ID to list UDF associations for. Use at_list_ci_categories to find valid IDs.
nextPageUrlstringnonullPagination 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).

[Autotask] List DNS records associated with a configuration item. Returns DNS record details including hostname, record type, and value. Requires a valid CI ID.

ParamTypeRequiredDefaultDescription
configItemIdintegeryesThe Autotask configuration item ID to list DNS records for.
nextPageUrlstringnonullPagination 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).

[Autotask] List SSL certificates associated with a configuration item. Returns certificate details including subject, issuer, and expiration date. Requires a valid CI ID.

ParamTypeRequiredDefaultDescription
configItemIdintegeryesThe Autotask configuration item ID to list SSL certificates for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_count_contractsFreeRead-onlyGet total count of contracts matching optional filters.
at_create_contractProDestructiveCreate a new contract record.
at_get_contractFreeRead-onlyRetrieve full details for a single contract by ID.
at_list_active_contractsFreeRead-onlyList contracts that are currently active.
at_list_company_contractsFreeRead-onlyList all contracts for a specific company.
at_list_contractsFreeRead-onlyQuery contracts with optional filters and pagination.
at_search_contractsFreeRead-onlySearch contracts by name.
at_update_contractProDestructiveUpdate an existing contract's fields.

[Autotask] Get total count of contracts matching optional filters. Returns a count object. Useful for pagination planning or contract portfolio dashboards.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON 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"}.

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list contracts for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"companyID","value":123}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against contract name.

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"contractName":"Managed Services v2","endDate":"2027-12-31"}.

Contract Sub-Resources

ToolPlanAccessSummary
at_create_contract_chargeProDestructiveAdd a charge to a contract.
at_list_contract_billing_rulesFreeRead-onlyList billing rules configured for a contract.
at_list_contract_blocksFreeRead-onlyList hour blocks associated with a contract.
at_list_contract_chargesFreeRead-onlyList charges posted against a contract.
at_list_contract_milestonesFreeRead-onlyList milestones associated with a contract.
at_list_contract_notesFreeRead-onlyList notes associated with a contract.
at_list_contract_ratesFreeRead-onlyList rates configured for a contract.
at_list_contract_retainersFreeRead-onlyList retainers associated with a contract.
at_list_contract_service_bundlesFreeRead-onlyList service bundles associated with a contract.
at_list_contract_servicesFreeRead-onlyList services associated with a contract.

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to add the charge to.
fieldsJsonstringyesJSON 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"}.

[Autotask] List billing rules configured for a contract. Returns rule details including frequency, amount, and effective dates. Useful for understanding recurring billing schedules.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list billing rules for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list blocks for.
nextPageUrlstringnonullPagination 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).

[Autotask] List charges posted against a contract. Returns charge details including description, amount, and date. Useful for billing reviews and expense tracking.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list charges for.
nextPageUrlstringnonullPagination 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).

[Autotask] List milestones associated with a contract. Returns milestone details including title, due date, and status. Useful for tracking contract deliverables and project timelines.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list milestones for.
nextPageUrlstringnonullPagination 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).

[Autotask] List notes associated with a contract. Returns note details including title, description, and created date. Useful for reviewing contract documentation and communication history.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list notes for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list rates for.
nextPageUrlstringnonullPagination 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).

[Autotask] List retainers associated with a contract. Returns retainer details including amount, period, and usage. Useful for tracking retainer consumption and billing.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list retainers for.
nextPageUrlstringnonullPagination 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).

[Autotask] List service bundles associated with a contract. Returns bundle details including name and included services. Useful for reviewing bundled service agreements.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list service bundles for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to list services for.
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_count_projectsFreeRead-onlyGet total count of projects matching optional filters.
at_create_projectProWriteCreate a new project record.
at_get_projectFreeRead-onlyRetrieve full details for a single project by ID.
at_list_active_projectsFreeRead-onlyList projects with Active or New status.
at_list_company_projectsFreeRead-onlyList all projects for a specific company.
at_list_projectsFreeRead-onlyQuery projects with optional filters and pagination.
at_search_projectsFreeRead-onlySearch projects by name.
at_update_projectProWriteUpdate an existing project's fields.

[Autotask] Get total count of projects matching optional filters. Returns a count object. Useful for pagination planning or dashboards.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the project to create. Must include projectName and companyID. Example: {"projectName":"Network Upgrade","companyID":12345,"status":1}.

[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.

ParamTypeRequiredDefaultDescription
projectIdintegeryesThe Autotask project ID.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list projects for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against project name.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"projectName":"Network Upgrade v2","status":5}.
projectIdintegeryesThe Autotask project ID to update.

Project Sub-Resources

ToolPlanAccessSummary
at_create_project_phaseProWriteCreate a phase under a project via POST /Projects//Phases.
at_create_project_taskProWriteCreate a new task within a project.
at_delete_project_phaseProDestructiveDelete a phase from a project via DELETE /Projects//Phases/.
at_get_project_phaseFreeRead-onlyRetrieve full details for a single project phase by ID.
at_get_project_taskFreeRead-onlyRetrieve full details for a single project task by ID.
at_list_project_chargesFreeRead-onlyList charges on a project.
at_list_project_notesFreeRead-onlyList notes on a project.
at_list_project_phasesFreeRead-onlyList phases within a project.
at_list_project_tasksFreeRead-onlyList tasks within a project.
at_update_project_phaseProWriteUpdate an existing project phase via PATCH /Projects//Phases.
at_update_project_taskProWriteUpdate an existing project task's fields.

[Autotask] Create a phase under a project via POST /Projects//Phases. Provide the phase as a JSON object in fieldsJson. Writable fields: title (required), startDate, dueDate, description, parentPhaseID, externalID. estimatedHours and isScheduled are read-only in Autotask and cannot be set here. Returns Autotask's itemId envelope.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the phase to create. Must include title. Example: {"title":"Discovery","startDate":"2026-09-07"}.
projectIdintegeryesThe Autotask project ID to create the phase in.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the task to create. Must include title. Example: {"title":"Configure firewall","status":1,"estimatedHours":4.0}.
projectIdintegeryesThe Autotask project ID to create the task in.

[Autotask] Delete a phase from a project via DELETE /Projects//Phases/. This is permanent. Phases on Baseline-type projects are read-only in Autotask and cannot be deleted. Use at_list_project_phases to find phase IDs.

ParamTypeRequiredDefaultDescription
phaseIdintegeryesThe Autotask phase ID to delete.
projectIdintegeryesThe Autotask project ID that owns the phase.

[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.

ParamTypeRequiredDefaultDescription
phaseIdintegeryesThe Autotask phase ID.

[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.

ParamTypeRequiredDefaultDescription
taskIdintegeryesThe Autotask task ID.

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
projectIdintegeryesThe Autotask project ID to list charges for.

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
projectIdintegeryesThe Autotask project ID to list notes for.

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
projectIdintegeryesThe Autotask project ID to list phases for.

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
projectIdintegeryesThe Autotask project ID to list tasks for.

[Autotask] Update an existing project phase via PATCH /Projects//Phases. fieldsJson must include the phase id along with the fields to change. Writable fields: title, startDate, dueDate, description, parentPhaseID, externalID. estimatedHours and isScheduled are read-only in Autotask and cannot be set here. Use at_get_project_phase to check current values before updating.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with the phase id and the fields to update. Example: {"id":33,"title":"Discovery (revised)"}.
projectIdintegeryesThe Autotask project ID that owns the phase.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"status":5,"estimatedHours":8.0}.
taskIdintegeryesThe Autotask task ID to update.

Time Entries

ToolPlanAccessSummary
at_count_time_entriesFreeRead-onlyGet total count of time entries matching optional filters.
at_create_time_entryProDestructiveCreate a new time entry record.
at_get_time_entryFreeRead-onlyRetrieve full details for a single time entry by ID.
at_list_recent_time_entriesFreeRead-onlyList time entries from the last N days.
at_list_resource_time_entriesFreeRead-onlyList time entries for a specific resource within an optional date range.
at_list_ticket_time_entriesFreeRead-onlyList time entries logged against a specific ticket.
at_list_time_entriesFreeRead-onlyQuery time entries with optional filters and pagination.
at_update_time_entryProDestructiveUpdate an existing time entry's fields.

[Autotask] Get total count of time entries matching optional filters. Returns a count object. Useful for utilization reporting and pagination planning.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"resourceID","value":12345}]. Omit for no filtering.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON 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"}.
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.

[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.

ParamTypeRequiredDefaultDescription
timeEntryIdintegeryesThe Autotask time entry ID.

[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.

ParamTypeRequiredDefaultDescription
daysintegerno7Number of days to look back (default 7).
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
endDatestringnonullEnd date filter in yyyy-MM-dd format. Returns entries on or before this date.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
resourceIdintegeryesThe Autotask resource ID to list time entries for.
startDatestringnonullStart date filter in yyyy-MM-dd format. Returns entries on or after this date.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ticketIdintegeryesThe Autotask ticket ID to list time entries for.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"resourceID","value":12345}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"hoursWorked":3.0,"summaryNotes":"Updated notes"}.
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.
timeEntryIdintegeryesThe Autotask time entry ID to update.

Resources (Technicians)

ToolPlanAccessSummary
at_get_resourceFreeRead-onlyRetrieve full details for a single resource (technician) by ID.
at_list_active_resourcesFreeRead-onlyList resources that are currently active.
at_list_resource_rolesFreeRead-onlyList resource roles with optional filters.
at_list_resource_skillsFreeRead-onlyList skills assigned to a specific resource.
at_list_resourcesFreeRead-onlyList resources (technicians/staff) with optional filters and pagination.
at_search_resourcesFreeRead-onlySearch resources by name or email.

[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.

ParamTypeRequiredDefaultDescription
resourceIdintegeryesThe Autotask resource ID.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
resourceIdintegeryesThe Autotask resource ID to list skills for.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against first name, last name, or email.

Opportunities (Sales)

ToolPlanAccessSummary
at_count_opportunitiesFreeRead-onlyGet total count of opportunities matching optional filters.
at_create_opportunityProWriteCreate a new opportunity record.
at_get_opportunityFreeRead-onlyRetrieve full details for a single opportunity by ID.
at_list_company_opportunitiesFreeRead-onlyList opportunities for a specific company.
at_list_open_opportunitiesFreeRead-onlyList opportunities that are currently open (not won or lost).
at_list_opportunitiesFreeRead-onlyQuery opportunities with optional filters and pagination.
at_search_opportunitiesFreeRead-onlySearch opportunities by title.
at_update_opportunityProWriteUpdate an existing opportunity's fields.

[Autotask] Get total count of opportunities matching optional filters. Returns a count object. Useful for pipeline dashboards and sales reporting.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the opportunity to create. Must include title and companyID. Example: {"title":"New Deal","companyID":12345,"amount":50000,"probability":75}.

[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.

ParamTypeRequiredDefaultDescription
opportunityIdintegeryesThe Autotask opportunity ID.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list opportunities for.
nextPageUrlstringnonullPagination 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).

[Autotask] List opportunities that are currently open (not won or lost). Useful for active sales pipeline views and forecasting.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against opportunity title.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"amount":75000,"probability":90,"status":2}.
opportunityIdintegeryesThe Autotask opportunity ID to update.

Quotes and Sales Orders

ToolPlanAccessSummary
at_create_quoteProWriteCreate a new quote record.
at_create_quote_itemProWriteAdd a line item to an existing quote.
at_delete_quote_itemProDestructiveDelete one line item from a quote.
at_get_quoteFreeRead-onlyRetrieve full details for a single quote by ID.
at_get_sales_orderFreeRead-onlyRetrieve full details for a single sales order by ID.
at_list_quotesFreeRead-onlyQuery quotes with optional filters and pagination.
at_list_sales_ordersFreeRead-onlyQuery sales orders with optional filters and pagination.
at_update_quoteProWriteUpdate an existing quote's fields.
at_update_quote_itemProWriteUpdate fields on one quote line item.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the quote to create. Must include name and opportunityID. Example: {"name":"Q-2026-001","opportunityID":12345,"description":"Annual support renewal"}.

[Autotask] Add a line item to an existing quote. Autotask writes quote lines under their quote, so the JSON must include quoteID. Required: quoteID, quantity, isOptional, lineDiscount, percentageDiscount and unitDiscount. Set exactly one of productID, chargeID, laborID, expenseID, shippingID, serviceID or serviceBundleID to say what the line sells. name is required except on Service and Service Bundle lines (quoteItemType 11 or 12). Optional: unitPrice, unitCost, description, isTaxable, periodType, taxCategoryID. averageCost, highestCost, markupRate, sortOrderID and totalEffectiveTax are read-only and are set by Autotask. Returns the created item's ID. Use at_list_quote_items to see the quote's lines.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the quote line. Example: {"quoteID":4411,"productID":9,"name":"Firewall appliance","quantity":2,"unitPrice":450,"isOptional":false,"lineDiscount":0,"percentageDiscount":0,"unitDiscount":0}.

[Autotask] Delete one line item from a quote. This cannot be undone: the line and its pricing are removed from the quote. The quote is found from the item itself. Use at_list_quote_items to confirm the item ID first.

ParamTypeRequiredDefaultDescription
quoteItemIdintegeryesThe Autotask quote item ID to delete.

[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.

ParamTypeRequiredDefaultDescription
quoteIdintegeryesThe Autotask quote ID.

[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.

ParamTypeRequiredDefaultDescription
salesOrderIdintegeryesThe Autotask sales order ID.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"name":"Q-2026-001 Rev2","description":"Updated scope"}.
quoteIdintegeryesThe Autotask quote ID to update.

[Autotask] Update fields on one quote line item. Only the fields you send change. The quote is found from the item itself, so quoteID is optional. Read-only fields (averageCost, highestCost, markupRate, sortOrderID, totalEffectiveTax) cannot be set. Returns the updated item's ID. Use at_list_quote_items to find item IDs and check current values.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with the fields to update. Example: {"quantity":3,"unitPrice":425,"description":"Includes rack kit"}.
quoteItemIdintegeryesThe Autotask quote item ID to update.

Scheduling and Calendar

ToolPlanAccessSummary
at_create_appointmentProWriteCreate a new appointment/calendar entry.
at_get_appointmentFreeRead-onlyRetrieve a single appointment by its numeric ID.
at_list_appointmentsFreeRead-onlyQuery appointments with optional filters.
at_list_resource_appointmentsFreeRead-onlyList appointments for a specific resource within an optional date range.
at_update_appointmentProWriteUpdate an existing appointment via PATCH.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON 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}.

[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.

ParamTypeRequiredDefaultDescription
appointmentIdintegeryesThe numeric Autotask appointment ID. Use at_list_appointments to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"gte","field":"startDateTime","value":"2026-03-01"}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
endDatestringnonullEnd date in yyyy-MM-dd format. Returns appointments starting on or before this date.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
resourceIdintegeryesThe numeric Autotask resource ID. Use at_list_resources to find valid IDs.
startDatestringnonullStart date in yyyy-MM-dd format. Returns appointments starting on or after this date.

[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.

ParamTypeRequiredDefaultDescription
appointmentIdintegeryesThe numeric Autotask appointment ID to update.
fieldsJsonstringyesJSON 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

ToolPlanAccessSummary
at_create_purchase_orderProDestructiveCreate a new purchase order.
at_get_expense_reportFreeRead-onlyRetrieve full details for a single expense report by ID.
at_get_purchase_orderFreeRead-onlyRetrieve full details for a single purchase order by ID.
at_list_expense_itemsFreeRead-onlyList expense items with optional filters and pagination.
at_list_expense_reportsFreeRead-onlyList expense reports with optional filters and pagination.
at_list_purchase_ordersFreeRead-onlyList purchase orders with optional filters and pagination.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the purchase order to create. Must include vendorID. Example: {"vendorID":12345,"status":1,"shipToAddress":"123 Main St"}.

[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.

ParamTypeRequiredDefaultDescription
reportIdintegeryesThe Autotask expense report ID.

[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.

ParamTypeRequiredDefaultDescription
purchaseOrderIdintegeryesThe Autotask purchase order ID.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isBillable","value":true}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
reportIdintegernonullOptional expense report ID to filter items for a specific report.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_count_invoicesFreeRead-onlyGet total count of invoices matching optional filters.
at_get_billing_itemFreeRead-onlyRetrieve full details for a single billing item by ID.
at_get_invoiceFreeRead-onlyRetrieve full details for a single invoice by ID.
at_list_billing_itemsFreeRead-onlyList billing items with optional filters and pagination.
at_list_company_invoicesFreeRead-onlyList invoices for a specific company.
at_list_invoicesFreeRead-onlyQuery invoices with optional filters and pagination.

[Autotask] Get total count of invoices matching optional filters. Returns a count object. Useful for billing dashboards and financial reporting.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"gte","field":"invoiceTotal","value":500}]. Omit for no filtering.

[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.

ParamTypeRequiredDefaultDescription
billingItemIdintegeryesThe Autotask billing item ID.

[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.

ParamTypeRequiredDefaultDescription
invoiceIdintegeryesThe Autotask invoice ID.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"type","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List invoices for a specific company. Returns all invoices linked to the given company ID. Useful for client billing reviews and account reconciliation.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to list invoices for.
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"invoiceTotal","value":1000}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_get_productFreeRead-onlyRetrieve full details for a single product by ID.
at_list_productsFreeRead-onlyList products from the product catalog with optional filters and pagination.
at_list_service_bundlesFreeRead-onlyList service bundles with optional filters and pagination.
at_list_servicesFreeRead-onlyList services from the service catalog with optional filters and pagination.
at_list_subscriptionsFreeRead-onlyList subscriptions with optional filters and pagination.
at_search_productsFreeRead-onlySearch products by name or SKU.

[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.

ParamTypeRequiredDefaultDescription
productIdintegeryesThe Autotask product ID.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
nextPageUrlstringnonullPagination 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).
searchstringyesSearch text to match against product name.

Documents and Attachments

ToolPlanAccessSummary
at_get_documentFreeRead-onlyRetrieve a single document by its numeric ID.
at_list_documentsFreeRead-onlyQuery documents and attachments with optional filters.
at_list_entity_documentsFreeRead-onlyList documents attached to a specific parent entity (e.g. Ticket, Company, Project).
at_search_documentsFreeRead-onlySearch documents by title keyword.

[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.

ParamTypeRequiredDefaultDescription
documentIdintegeryesThe numeric Autotask document ID. Use at_list_documents or at_search_documents to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"publish","value":1}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
parentIdintegeryesThe numeric ID of the parent entity.
parentTypestringyesThe parent entity type. Valid values: Ticket, Company, Contact, Project, Opportunity, ConfigurationItem.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
searchstringyesSearch term to match against document titles. Case-insensitive contains match.

Attachments

ToolPlanAccessSummary
at_get_attachmentFreeRead-onlyRetrieve a single attachment info record by its numeric ID.
at_list_attachmentsFreeRead-onlyQuery attachment info records across all entity types.
at_list_ci_note_attachmentsFreeRead-onlyQuery attachments on configuration item notes.
at_list_company_note_attachmentsFreeRead-onlyQuery attachments on company notes.
at_list_contract_note_attachmentsFreeRead-onlyQuery attachments on contract notes.
at_list_project_note_attachmentsFreeRead-onlyQuery attachments on project notes.
at_list_time_entry_attachmentsFreeRead-onlyQuery attachments on time entries.

[Autotask] Retrieve a single attachment info record by its numeric ID. Returns attachment metadata including filename, size, content type, and parent entity reference.

ParamTypeRequiredDefaultDescription
attachmentIdintegeryesThe numeric Autotask attachment info ID.

[Autotask] Query attachment info records across all entity types. Returns attachment metadata including filename, size, and parent entity. Use filterJson for advanced queries.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentType","value":"Ticket"}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query attachments on configuration item notes. Filter by parentID (CI note ID) to narrow results.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query attachments on company notes. Filter by parentID (company note ID) to narrow results.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query attachments on contract notes. Filter by parentID (contract note ID) to narrow results.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query attachments on project notes. Filter by parentID (project note ID) to narrow results.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query attachments on time entries. Filter by parentID (time entry ID) to narrow results.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_create_kb_articleProWriteCreate a new knowledge base article.
at_get_kb_articleFreeRead-onlyRetrieve a single knowledge base article by its numeric ID.
at_list_kb_articlesFreeRead-onlyQuery knowledge base articles with optional filters.
at_search_kb_articlesFreeRead-onlySearch knowledge base articles by keyword.
at_update_kb_articleProWriteUpdate an existing knowledge base article via PATCH.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the KB article to create. Must include title. Example: {"title":"How to reset password","content":"Step 1...","publish":true}.

[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.

ParamTypeRequiredDefaultDescription
articleIdintegeryesThe numeric Autotask KB article ID. Use at_list_kb_articles or at_search_kb_articles to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"eq","field":"publish","value":true}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
searchstringyesSearch term to match against article titles. Case-insensitive contains match.

[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.

ParamTypeRequiredDefaultDescription
articleIdintegeryesThe numeric Autotask KB article ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"title":"Updated title","content":"Updated body..."}. Field names must match Autotask API field names.

Surveys and CSAT

ToolPlanAccessSummary
at_get_survey_resultFreeRead-onlyRetrieve a single survey result by its numeric ID.
at_list_survey_resultsFreeRead-onlyQuery customer satisfaction survey results with optional filters.

[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.

ParamTypeRequiredDefaultDescription
surveyResultIdintegeryesThe numeric Autotask survey result ID. Use at_list_survey_results to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Example: [{"op":"gte","field":"rating","value":4}]. Omit for no filtering.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_get_api_thresholdFreeRead-onlyGet the current API request threshold and usage information.
at_get_entity_infoFreeRead-onlyGet entity information including capabilities, field count, and whether the entity supports create/update/delete operations.
at_get_field_infoFreeRead-onlyGet detailed field definitions for an entity including data types, required fields, picklist values, and validation rules.
at_get_udf_infoFreeRead-onlyGet user-defined field (UDF) definitions for an entity.
at_get_zone_infoFreeRead-onlyGet the Autotask zone/datacenter URL for this tenant.
at_list_picklist_valuesFreeRead-onlyGet picklist values for a specific field on an entity.
at_list_ticket_categoriesFreeRead-onlyList ticket categories.
at_list_ticket_sourcesFreeRead-onlyList ticket source picklist values.

[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.

[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.

ParamTypeRequiredDefaultDescription
entityNamestringyesThe Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems, Resources, Projects, TimeEntries, Contracts.

[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.

ParamTypeRequiredDefaultDescription
entityNamestringyesThe Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems, Resources, Projects, TimeEntries, Contracts.

[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.

ParamTypeRequiredDefaultDescription
entityNamestringyesThe Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems, Resources, Projects.

[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.

[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.

ParamTypeRequiredDefaultDescription
entityNamestringyesThe Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems.
fieldNamestringyesThe field name to get picklist values for. Examples: status, priority, queueID, companyType, ticketType.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

Lookups and Reference Data

ToolPlanAccessSummary
at_list_billing_codesFreeRead-onlyList billing codes (work types).
at_list_company_classificationsFreeRead-onlyList company classification picklist values.
at_list_company_typesFreeRead-onlyList company type picklist values.
at_list_departmentsFreeRead-onlyList all departments.
at_list_ticket_prioritiesFreeRead-onlyList ticket priority picklist values.
at_list_ticket_queuesFreeRead-onlyList ticket queue picklist values.
at_list_ticket_statusesFreeRead-onlyList ticket status picklist values.
at_list_ticket_typesFreeRead-onlyList ticket type picklist values.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

[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.

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

[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.

[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.

[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.

Analytics

ToolPlanAccessSummary
at_open_ticket_age_distributionFreeRead-onlyAnalyze open tickets grouped by age bucket (0-7d, 8-14d, 15-30d, 31-60d, 60d+).
at_open_ticket_summaryFreeRead-onlyQuick summary of all open tickets grouped by queue, priority, and age bucket.
at_priority_distributionFreeRead-onlyOpen ticket count per priority level.
at_queue_performance_comparisonFreeRead-onlyCompare ticket metrics across queues.
at_stale_ticket_reportFreeRead-onlyIdentify open tickets with no activity beyond a threshold, indicating potential neglect or bottlenecks.
at_team_workload_balanceFreeRead-onlyView open ticket distribution across resources to identify workload imbalances.
at_ticket_resolution_analyticsFreeRead-onlyAnalyze resolution metrics for closed tickets in a date range.
at_ticket_source_analysisFreeRead-onlyAnalyze ticket creation sources (email, phone, portal, etc.).
at_ticket_volume_trendsFreeRead-onlyTrack ticket volume over multiple time periods to identify trends.
at_unassigned_ticket_reportFreeRead-onlyCount and list unassigned open tickets grouped by queue.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum tickets to analyze (default 500, max 500). Larger sets give more accurate distribution.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum tickets to analyze (default 500, max 500).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum tickets to analyze (default 500, max 500).

[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.

ParamTypeRequiredDefaultDescription
daysintegerno30Number of days to look back (default 30).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum results to return (default 500, max 500).
staleDaysintegerno7Number of days without activity to consider a ticket stale (default 7). Lower for urgent triage, higher for periodic reviews.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum tickets to analyze (default 500, max 500).

[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.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date in yyyy-MM-dd format. Defines the end of the analysis period.
startDatestringyesStart date in yyyy-MM-dd format. Defines the beginning of the analysis period.

[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.

ParamTypeRequiredDefaultDescription
endDatestringnonullEnd date in yyyy-MM-dd format (default: today).
startDatestringnonullStart date in yyyy-MM-dd format (default: 30 days ago).

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum results to return (default 500, max 500).

Advanced Analytics

ToolPlanAccessSummary
at_after_hours_impact_reportProRead-onlyAnalyze after-hours ticket volume and impact.
at_contract_utilizationProRead-onlyContract hours used vs allocated.
at_csat_reportProRead-onlyCustomer satisfaction metrics from survey responses.
at_dispatch_optimizerProRead-onlyRank resources for optimal ticket dispatch.
at_escalation_analysisProRead-onlyAnalyze escalation patterns for tickets in a date range.
at_first_response_time_analyticsProRead-onlyMeasure first response times for tickets in a date range.
at_sla_breach_alertsProRead-onlyIdentify tickets at risk of SLA breach.
at_sla_compliance_dashboardProRead-onlySLA compliance metrics for tickets in a date range.
at_technician_utilizationProRead-onlyResource utilization metrics showing billable vs non-billable hours.
at_timesheet_summaryProRead-onlyTime entry aggregation for a date range.

[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.

ParamTypeRequiredDefaultDescription
endDatestringnonullEnd date in yyyy-MM-dd format (optional). Defaults to today.
startDatestringnonullStart date in yyyy-MM-dd format (optional). Defaults to 30 days ago.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
contractIdintegernonullFilter by specific contract ID (optional). Use at_list_contracts to find valid IDs. If omitted, returns all active contracts.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
endDatestringnonullEnd date in yyyy-MM-dd format (optional). Defaults to today.
startDatestringnonullStart date in yyyy-MM-dd format (optional). Defaults to 90 days ago.

[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.

ParamTypeRequiredDefaultDescription
queueIdintegernonullFilter by queue ID (optional). Limits analysis to resources associated with a specific queue.

[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.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date in yyyy-MM-dd format. Defines the end of the analysis period.
startDatestringyesStart date in yyyy-MM-dd format. Defines the beginning of the analysis period.

[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.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date in yyyy-MM-dd format. Defines the end of the analysis period.
startDatestringyesStart date in yyyy-MM-dd format. Defines the beginning of the analysis period.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
warningMinutesintegerno60Warning threshold in minutes before SLA breach (default 60). Tickets within this window are flagged as at-risk.

[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.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date in yyyy-MM-dd format. Defines the end of the analysis period.
startDatestringyesStart date in yyyy-MM-dd format. Defines the beginning of the analysis period.

[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.

ParamTypeRequiredDefaultDescription
endDatestringnonullEnd date in yyyy-MM-dd format (optional). Defaults to today.
resourceIdintegernonullFilter by specific resource ID (optional). Use at_list_resources to find valid IDs. If omitted, returns all resources.
startDatestringnonullStart date in yyyy-MM-dd format (optional). Defaults to current month start.
targetUtilizationintegerno80Target utilization percentage (default 80). Used to flag under/over-utilized resources.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
endDatestringyesEnd date in yyyy-MM-dd format.
resourceIdintegernonullFilter by resource ID (optional). Use at_list_resources to find valid IDs.
startDatestringyesStart date in yyyy-MM-dd format.

Premium Analytics

ToolPlanAccessSummary
at_client_health_scoreProRead-onlyComposite 0-100 health score for a company based on ticket volume trends, resolution times, SLA compliance, and satisfaction.
at_contract_profitability_analysisProRead-onlyAnalyze contract profitability by comparing revenue to labor cost.
at_effective_hourly_rateProRead-onlyCalculate the effective hourly rate across billing for a date range.
at_mrr_analysisProRead-onlyMonthly recurring revenue analysis from active contracts.
at_qbr_data_packProRead-onlyQuarterly Business Review data package for a company.
at_revenue_leakage_scanProRead-onlyDetect unbilled time entries, missed charges, and other revenue leakage.
at_scope_creep_detectorProRead-onlyDetect out-of-scope work and scope creep across contracts and projects.
at_unprofitable_contractsProRead-onlyIdentify contracts where labor cost exceeds revenue.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID to score. Use at_list_companies to find valid IDs.
lookbackDaysintegerno90Number of days to look back for analysis (default 90).

[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.

ParamTypeRequiredDefaultDescription
contractIdintegeryesThe Autotask contract ID to analyze. Use at_list_contracts to find valid IDs.
hourlyRatenumberno150Hourly cost rate for labor cost estimation (default 150.00).

[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.

ParamTypeRequiredDefaultDescription
endDatestringyesEnd date in yyyy-MM-dd format.
startDatestringyesStart date in yyyy-MM-dd format.
targetRatenumberno150Target hourly rate for comparison (default 150.00).

[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.

ParamTypeRequiredDefaultDescription
includeBreakdownbooleannotrueInclude per-contract MRR breakdown in results (default true).
trendMonthsintegerno6Number of months to include in trend analysis (default 6).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID. Use at_list_companies to find valid IDs.
quarterEndstringyesQuarter end date in yyyy-MM-dd format (e.g., 2025-03-31).
quarterStartstringyesQuarter start date in yyyy-MM-dd format (e.g., 2025-01-01).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
lookbackDaysintegerno30Number of days to look back (default 30).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
lookbackDaysintegerno30Number of days to look back (default 30).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
hourlyRatenumberno150Hourly cost rate for profitability calculation (default 150.00).

Intelligence

ToolPlanAccessSummary
at_client_offboarding_auditProRead-onlyAudit open items before client offboarding.
at_client_onboarding_checklistProRead-onlyCheck onboarding completeness for a company.
at_client_risk_assessmentProRead-onlyAssess risk factors for a client based on ticket trends, SLA compliance, satisfaction scores, and contract status.
at_company_360_viewProRead-onlyComprehensive 360-degree view of a company.
at_contract_renewal_pipelineProRead-onlyList contracts approaching renewal or expiration.
at_daily_operations_briefingProRead-onlyMorning briefing with key operational metrics.
at_kb_gap_analysisProRead-onlyIdentify missing knowledge base topics by analyzing recurring ticket themes that lack KB articles.
at_recurring_issue_detectorProRead-onlyDetect recurring issues based on ticket patterns.
at_ticket_similarity_searchProRead-onlyFind tickets similar to a given ticket based on title, description, and categorization.
at_ticket_triage_assistProRead-onlyTriage assistance for a ticket.
at_unbilled_time_reportProRead-onlyIdentify unbilled time entries across companies and contracts.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID. Use at_list_companies to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID. Use at_list_companies to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID. Use at_list_companies to find valid IDs.
lookbackMonthsintegerno3Number of months to look back for analysis (default 3).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID. Use at_list_companies to find valid IDs.

[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.

ParamTypeRequiredDefaultDescription
daysAheadintegerno90Number of days ahead to look for expiring contracts (default 90).

[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.

[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.

ParamTypeRequiredDefaultDescription
lookbackDaysintegerno30Number of days to look back for ticket analysis (default 30).

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
lookbackDaysintegerno30Number of days to look back (default 30).
minOccurrencesintegerno3Minimum occurrences to flag as recurring (default 3).

[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.

ParamTypeRequiredDefaultDescription
maxResultsintegerno10Maximum similar tickets to return (default 10).
ticketIdintegeryesThe Autotask ticket ID to find similar tickets for.

[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.

ParamTypeRequiredDefaultDescription
ticketIdintegeryesThe Autotask ticket ID to triage.

[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.

ParamTypeRequiredDefaultDescription
companyIdintegernonullFilter by company ID (optional). Use at_list_companies to find valid IDs.
contractIdintegernonullFilter by contract ID (optional). Use at_list_contracts to find valid IDs.

Cross-Domain

ToolPlanAccessSummary
at_first_contact_resolutionProRead-onlyCalculate first contact resolution (FCR) rate for tickets in a date range.
at_ticket_backlog_analysisProRead-onlyDeep analysis of the ticket backlog.
at_ticket_handoff_analysisProRead-onlyAnalyze ticket reassignment patterns for tickets in a date range.
at_time_entry_anomaly_scanProRead-onlyDetect unusual time entry patterns such as excessive hours, after-hours entries, or inconsistent logging.

[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.

ParamTypeRequiredDefaultDescription
endDatestringnonullEnd date in yyyy-MM-dd format (optional). Defaults to today.
startDatestringnonullStart date in yyyy-MM-dd format (optional). Defaults to 30 days ago.

[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.

[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.

ParamTypeRequiredDefaultDescription
endDatestringnonullEnd date in yyyy-MM-dd format (optional). Defaults to today.
startDatestringnonullStart date in yyyy-MM-dd format (optional). Defaults to 30 days ago.

[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.

ParamTypeRequiredDefaultDescription
lookbackDaysintegerno30Number of days to look back (default 30).
resourceIdintegernonullFilter by resource ID (optional). Use at_list_resources to find valid IDs.

Resource Sub-Resources

ToolPlanAccessSummary
at_create_comanaged_associationProDestructiveCreate a new co-managed association between a resource and a company.
at_create_resource_service_desk_roleProDestructiveCreate a new service desk role assignment for a resource.
at_delete_comanaged_associationProDestructiveDelete a co-managed association by its numeric ID.
at_list_additional_resource_time_offFreeRead-onlyQuery additional time off records for resources beyond standard requests.
at_list_client_portal_usersFreeRead-onlyQuery client portal user records.
at_list_comanaged_associationsFreeRead-onlyQuery co-managed association records.
at_list_resource_attachmentsFreeRead-onlyQuery attachment records associated with resources.
at_list_resource_daily_availabilityFreeRead-onlyQuery daily availability records for resources.
at_list_resource_role_departmentsFreeRead-onlyQuery resource role department assignments.
at_list_resource_role_queuesFreeRead-onlyQuery resource role queue assignments.
at_list_resource_service_desk_rolesFreeRead-onlyQuery service desk role assignments for resources.
at_list_resource_time_off_balancesFreeRead-onlyQuery time off balance records for resources.
at_list_time_off_request_approversFreeRead-onlyQuery time off request approver records.

[Autotask] Create a new co-managed association between a resource and a company. Returns the created record with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the co-managed association to create. Include resourceID and companyID.

[Autotask] Create a new service desk role assignment for a resource. Returns the created record with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the resource service desk role to create. Include resourceID and roleID.

[Autotask] Delete a co-managed association by its numeric ID. This permanently removes the association.

ParamTypeRequiredDefaultDescription
associationIdintegeryesThe numeric Autotask co-managed association ID to delete.

[Autotask] Query additional time off records for resources beyond standard requests. Returns supplemental time off data. Use filterJson to narrow by resourceID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query client portal user records. Returns portal user details including username, contact association, and security level. Use filterJson for advanced queries.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"contactID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query co-managed association records. Returns associations between resources and co-managed companies. Use filterJson to narrow by resourceID or companyID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query attachment records associated with resources. Returns attachment metadata including filename, size, and content type. Use filterJson to narrow by parentID (resource ID).

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query resource role department assignments. Returns mappings between resources, roles, and departments. Use filterJson to narrow by resourceID or departmentID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query resource role queue assignments. Returns mappings between resources, roles, and queues. Use filterJson to narrow by resourceID or queueID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query time off request approver records. Returns approver assignments including resource and approver resource IDs. Use filterJson to narrow by resourceID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_approve_time_off_requestProDestructiveApprove a pending time off request by its numeric ID.
at_count_time_off_requestsFreeRead-onlyCount time off requests matching optional filters.
at_create_time_off_requestProWriteCreate a new time off request.
at_get_time_off_requestFreeRead-onlyRetrieve a single time off request by its numeric ID.
at_list_resource_time_off_requestsFreeRead-onlyList time off requests for a specific resource.
at_list_time_off_requestsFreeRead-onlyQuery time off requests with optional filters.
at_reject_time_off_requestProDestructiveReject a pending time off request by its numeric ID with a reason.
at_update_time_off_requestProWriteUpdate an existing time off request.

[Autotask] Approve a pending time off request by its numeric ID. Returns the approval result. Only works on requests in a pending approval status.

ParamTypeRequiredDefaultDescription
timeOffRequestIdintegeryesThe numeric Autotask time off request ID to approve.

[Autotask] Count time off requests matching optional filters. Returns the total number of matching requests without fetching data.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Omit for no filtering.

[Autotask] Create a new time off request. Returns the created request with its assigned ID. Include resourceID, startDateTime, endDateTime, and timeOffPolicyID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the time off request to create. Include resourceID, startDateTime, endDateTime, and timeOffPolicyID.

[Autotask] Retrieve a single time off request by its numeric ID. Returns full details including resource, dates, hours, status, and approval information.

ParamTypeRequiredDefaultDescription
timeOffRequestIdintegeryesThe numeric Autotask time off request ID.

[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.

ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
resourceIdintegeryesThe Autotask resource ID to list time off requests for.

[Autotask] Query time off requests with optional filters. Returns paginated time off request summaries including status, dates, and hours. Use filterJson for advanced queries.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"status","value":1}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
rejectionReasonstringyesReason for rejecting the time off request.
timeOffRequestIdintegeryesThe numeric Autotask time off request ID to reject.

[Autotask] Update an existing time off request. The id field is automatically included. Returns the updated request.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"status":2}.
timeOffRequestIdintegeryesThe numeric Autotask time off request ID to update.

Task Sub-Resources

ToolPlanAccessSummary
at_create_task_noteProDestructiveCreate a new note on a project task.
at_create_task_predecessorProWriteCreate a new task predecessor dependency.
at_create_task_secondary_resourceProWriteAssign an additional resource to a task.
at_delete_task_predecessorProDestructiveDelete a task predecessor dependency by its numeric ID.
at_delete_task_secondary_resourceProDestructiveRemove a secondary resource assignment from a task by its numeric ID.
at_get_task_noteFreeRead-onlyRetrieve a single task note by its numeric ID.
at_list_task_attachmentsFreeRead-onlyQuery attachment records associated with tasks.
at_list_task_notesFreeRead-onlyQuery notes on project tasks.
at_list_task_predecessorsFreeRead-onlyQuery task predecessor relationships.
at_list_task_secondary_resourcesFreeRead-onlyQuery secondary resource assignments on tasks.
at_update_task_noteProDestructiveUpdate an existing task note.

[Autotask] Create a new note on a project task. Returns the created note with its assigned ID. REQUIRED fields: taskID, description, AND noteType. noteType is an integer picklist whose valid values are configured per Autotask instance -- there is no universal default -- so discover them first with at_list_picklist_values (entityName='TaskNotes', fieldName='noteType') or at_get_field_info (entityName='TaskNotes'). TaskNotes and TicketNotes have SEPARATE noteType picklists, so discover the values for TaskNotes specifically rather than reusing a value from a ticket note.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the task note to create. Must include taskID (integer), description (string), and noteType (integer picklist -- see the tool description for how to discover the valid values for this Autotask instance). Example: {"taskID":12345,"description":"Work performed","noteType":3}.
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.

[Autotask] Create a new task predecessor dependency. Returns the created dependency record with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the task predecessor to create. Include predecessorTaskID and successorTaskID.

[Autotask] Assign an additional resource to a task. Returns the created assignment record with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object for the task secondary resource to create. Include taskID and resourceID.

[Autotask] Delete a task predecessor dependency by its numeric ID. This permanently removes the dependency.

ParamTypeRequiredDefaultDescription
taskPredecessorIdintegeryesThe numeric Autotask task predecessor ID to delete.

[Autotask] Remove a secondary resource assignment from a task by its numeric ID. This permanently removes the assignment.

ParamTypeRequiredDefaultDescription
taskSecondaryResourceIdintegeryesThe numeric Autotask task secondary resource ID to delete.

[Autotask] Retrieve a single task note by its numeric ID. Returns full note details including title, description, creator, and timestamps.

ParamTypeRequiredDefaultDescription
taskNoteIdintegeryesThe numeric Autotask task note ID.

[Autotask] Query attachment records associated with tasks. Returns attachment metadata including filename, size, and content type. Use filterJson to narrow by parentID (task ID).

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query notes on project tasks. Returns note details including title, description, and creator. Use filterJson to narrow by taskID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. When provided, typed filter params are ignored.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
taskIdintegernonullFilter by task ID.

[Autotask] Query task predecessor relationships. Returns dependency links between tasks including lag time. Use filterJson to narrow by successorTaskID or predecessorTaskID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"successorTaskID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query secondary resource assignments on tasks. Returns additional resource assignments beyond the primary. Use filterJson to narrow by taskID or resourceID.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array. Example: [{"op":"eq","field":"taskID","value":123}]
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing task note. The id field is automatically included. Returns the updated note.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Example: {"description":"Updated note"}.
impersonationResourceIdstringnonullOptional. Autotask resource id to write AS (ImpersonationResourceId). Signed-in members with a stored Autotask identity get it automatically; endpoints must pass it. The API user's security level must allow impersonation.
taskNoteIdintegeryesThe numeric Autotask task note ID to update.

Webhooks

ToolPlanAccessSummary
at_create_webhookProWriteCreate a new webhook for a specific entity type.
at_create_webhook_fieldProWriteAdd a field to a webhook tracked fields.
at_create_webhook_udf_fieldProWriteAdd a user-defined field to a webhook tracked UDF fields.
at_delete_webhookProDestructiveDelete a webhook by its numeric ID and entity type.
at_delete_webhook_fieldProDestructiveRemove a field from a webhook tracked fields.
at_delete_webhook_udf_fieldProDestructiveRemove a user-defined field from a webhook tracked UDF fields.
at_get_webhookFreeRead-onlyRetrieve a single webhook by its numeric ID and entity type.
at_list_webhook_error_logsFreeRead-onlyQuery webhook event error logs.
at_list_webhook_excluded_resourcesFreeRead-onlyList resources excluded from triggering a specific webhook.
at_list_webhook_fieldsFreeRead-onlyList fields configured for a specific webhook.
at_list_webhook_udf_fieldsFreeRead-onlyList user-defined fields (UDFs) configured for a specific webhook.
at_list_webhooksFreeRead-onlyQuery webhooks for a specific entity type.
at_manage_webhook_excluded_resourceProDestructiveCreate or delete an excluded resource for a webhook.
at_update_webhookProWriteUpdate an existing webhook via PATCH.

[Autotask] Create a new webhook for a specific entity type. Requires webhook configuration data including URL and event types.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with webhook configuration. Must include fields like deactivationUrl, name, webhookUrl, etc.
entityTypestringyesThe entity type to create the webhook for. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.

[Autotask] Add a field to a webhook tracked fields. When this field changes on the entity, the webhook will fire.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with field configuration. Must include the fieldID to track.
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
webhookIdintegeryesThe numeric Autotask webhook ID.

[Autotask] Add a user-defined field to a webhook tracked UDF fields. When this UDF changes on the entity, the webhook will fire.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with UDF field configuration. Must include the udfFieldID to track.
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
webhookIdintegeryesThe numeric Autotask webhook ID.

[Autotask] Delete a webhook by its numeric ID and entity type. This permanently removes the webhook configuration.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
idintegeryesThe numeric Autotask webhook ID to delete.

[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.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
fieldIdintegeryesThe numeric Autotask webhook field ID to delete.
webhookIdintegeryesThe numeric Autotask webhook ID that owns the field.

[Autotask] Remove a user-defined field from a webhook tracked UDF fields. Requires the parent webhook ID -- use at_list_webhooks to find it.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
fieldIdintegeryesThe numeric Autotask webhook UDF field ID to delete.
webhookIdintegeryesThe numeric Autotask webhook ID that owns the UDF field.

[Autotask] Retrieve a single webhook by its numeric ID and entity type. Returns full webhook configuration details.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
idintegeryesThe numeric Autotask webhook ID.

[Autotask] Query webhook event error logs. Returns error details for failed webhook deliveries including error messages, timestamps, and related webhook IDs.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List resources excluded from triggering a specific webhook. Returns resources whose changes will not fire the webhook.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
webhookIdintegeryesThe numeric Autotask webhook ID.

[Autotask] List fields configured for a specific webhook. Returns the fields that trigger webhook notifications when changed.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
webhookIdintegeryesThe numeric Autotask webhook ID.

[Autotask] List user-defined fields (UDFs) configured for a specific webhook. Returns the UDF fields that trigger webhook notifications when changed.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
webhookIdintegeryesThe numeric Autotask webhook ID.

[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.

ParamTypeRequiredDefaultDescription
entityTypestringyesThe entity type to query webhooks for. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Create or delete an excluded resource for a webhook. Use action create with dataJson to add, or action delete with excludedResourceId to remove.

ParamTypeRequiredDefaultDescription
actionstringyesThe action to perform: create or delete.
dataJsonstringnonullJSON object with excluded resource data (required for create). Must include the resourceID.
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.
excludedResourceIdintegernonullThe numeric excluded resource ID to delete (required for delete).
webhookIdintegernonullThe numeric Autotask webhook ID that owns the excluded resource (required for both create and delete).

[Autotask] Update an existing webhook via PATCH. Provide the entity type and a JSON object with the id field and fields to update.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with the id field and fields to update.
entityTypestringyesThe entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote.

Change Management

ToolPlanAccessSummary
at_create_change_order_chargeProDestructiveCreate a new charge on a change order.
at_create_change_request_linkProWriteCreate a new link between a change request and another entity.
at_delete_change_order_chargeProDestructiveDelete a change order charge by its numeric ID.
at_delete_change_request_linkProDestructiveDelete a change request link by its numeric ID.
at_list_change_order_chargesFreeRead-onlyQuery change order charges with optional filters.
at_list_change_request_linksFreeRead-onlyQuery change request links with optional filters.
at_list_sla_resultsFreeRead-onlyQuery service level agreement results with optional filters.
at_update_change_order_chargeProDestructiveUpdate an existing change order charge via PATCH.

[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.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with charge data. Must include changeOrderID, billingCodeID, and other required fields.

[Autotask] Delete a change order charge by its numeric ID. This permanently removes the charge from the change order.

ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask change order charge ID to delete.

[Autotask] Query change order charges with optional filters. Returns paginated charge records associated with change orders including amount, billing code, and description.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query service level agreement results with optional filters. Returns SLA compliance data including target metrics, actual metrics, and pass/fail status for tickets.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with the id field and fields to update.

Document Sub-Resources

ToolPlanAccessSummary
at_create_document_categoryProWriteCreate a new document category.
at_create_document_checklist_itemProWriteCreate a new checklist item within a document.
at_create_document_noteProDestructiveCreate a new note on a document.
at_create_document_tag_associationProWriteCreate a new tag association on a document.
at_create_document_ticket_associationProWriteCreate a new association between a document and a ticket.
at_delete_document_categoryProDestructiveDelete a document category by its numeric ID.
at_delete_document_ticket_associationProDestructiveDelete an association between a document and a ticket by its numeric ID.
at_get_document_plain_textFreeRead-onlyQuery the plain text content of documents.
at_list_checklist_librariesFreeRead-onlyQuery checklist libraries with optional filters.
at_list_document_attachmentsFreeRead-onlyQuery file attachments associated with documents.
at_list_document_categoriesFreeRead-onlyQuery document categories with optional filters.
at_list_document_checklist_itemsFreeRead-onlyQuery checklist items within documents.
at_list_document_ci_associationsFreeRead-onlyQuery associations between documents and configuration items.
at_list_document_notesFreeRead-onlyQuery notes attached to documents with optional filters.
at_list_document_tag_associationsFreeRead-onlyQuery tag associations on documents.
at_list_document_ticket_associationsFreeRead-onlyQuery associations between documents and tickets.

[Autotask] Create a new document category. Returns the created category with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with category data. Must include name field.

[Autotask] Create a new checklist item within a document. Returns the created checklist item with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with checklist item data. Must include documentID and itemName fields.

[Autotask] Create a new note on a document. Returns the created note with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with note data. Must include documentID and noteText fields.

[Autotask] Create a new tag association on a document. Returns the created association with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with tag association data. Must include documentID and tagID fields.

[Autotask] Create a new association between a document and a ticket. Returns the created association with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with association data. Must include documentID and ticketID fields.

[Autotask] Delete a document category by its numeric ID. This permanently removes the category.

ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask document category ID to delete.

[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.

ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask document-ticket association ID to delete.

[Autotask] Query the plain text content of documents. Returns the extracted text content from documents, useful for searching and indexing.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query checklist libraries with optional filters. Returns available checklist templates that can be applied to documents.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query file attachments associated with documents. Returns attachment metadata including file name, size, and content type.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query document categories with optional filters. Returns available categories used to organize and classify documents.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query checklist items within documents. Returns checklist item details including text, completion status, and sort order.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query associations between documents and configuration items. Returns link records showing which documents are attached to which CIs.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query notes attached to documents with optional filters. Returns note content, author, and timestamps.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query tag associations on documents. Returns which tags are applied to which documents.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query associations between documents and tickets. Returns link records showing which documents are attached to which tickets.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_create_kb_article_noteProDestructiveCreate a new note on a knowledge base article.
at_create_kb_article_tag_associationProWriteCreate a new tag association on a knowledge base article.
at_create_kb_article_ticket_associationProWriteCreate a new association between a knowledge base article and a ticket.
at_create_kb_categoryProWriteCreate a new knowledge base category.
at_delete_kb_article_tag_associationProDestructiveDelete a tag association from a knowledge base article by its numeric ID.
at_delete_kb_article_ticket_associationProDestructiveDelete an association between a knowledge base article and a ticket by its numeric ID.
at_delete_kb_categoryProDestructiveDelete a knowledge base category by its numeric ID.
at_get_kb_article_plain_textFreeRead-onlyQuery the plain text content of knowledge base articles.
at_list_kb_article_attachmentsFreeRead-onlyQuery file attachments associated with knowledge base articles.
at_list_kb_article_document_associationsFreeRead-onlyQuery associations between knowledge base articles and documents.
at_list_kb_article_notesFreeRead-onlyQuery notes attached to knowledge base articles with optional filters.
at_list_kb_article_tag_associationsFreeRead-onlyQuery tag associations on knowledge base articles.
at_list_kb_article_ticket_associationsFreeRead-onlyQuery associations between knowledge base articles and tickets.
at_list_kb_categoriesFreeRead-onlyQuery knowledge base categories with optional filters.

[Autotask] Create a new note on a knowledge base article. Returns the created note with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with note data. Must include knowledgeBaseArticleID and noteText fields.

[Autotask] Create a new tag association on a knowledge base article. Returns the created association with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with tag association data. Must include knowledgeBaseArticleID and tagID fields.

[Autotask] Create a new association between a knowledge base article and a ticket. Returns the created association with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with association data. Must include knowledgeBaseArticleID and ticketID fields.

[Autotask] Create a new knowledge base category. Returns the created category with its assigned ID.

ParamTypeRequiredDefaultDescription
dataJsonstringyesJSON object with category data. Must include name field.
ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask article-tag association ID to delete.
ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask article-ticket association ID to delete.

[Autotask] Delete a knowledge base category by its numeric ID. This permanently removes the category.

ParamTypeRequiredDefaultDescription
idintegeryesThe numeric Autotask knowledge base category ID to delete.

[Autotask] Query the plain text content of knowledge base articles. Returns extracted text content useful for searching and indexing.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query file attachments associated with knowledge base articles. Returns attachment metadata including file name, size, and content type.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query associations between knowledge base articles and documents. Returns link records showing which articles are related to which documents.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query notes attached to knowledge base articles with optional filters. Returns note content, author, and timestamps.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query tag associations on knowledge base articles. Returns which tags are applied to which articles.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query associations between knowledge base articles and tickets. Returns link records showing which articles are related to which tickets.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Query knowledge base categories with optional filters. Returns available categories used to organize KB articles.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullRaw Autotask filter JSON array for advanced queries.
maxRecordsintegerno500Maximum number of results to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_create_contract_exclusion_setProDestructiveCreate a new contract exclusion set.
at_create_contract_service_adjustmentProDestructiveCreate a new service adjustment on a contract.
at_create_contract_ticket_purchaseProDestructiveCreate a new ticket purchase on a contract.
at_delete_contract_exclusion_setProDestructiveDelete a contract exclusion set by ID.
at_list_billing_item_approval_levelsFreeRead-onlyList billing item approval levels.
at_list_contract_block_hour_factorsFreeRead-onlyList block hour factors for contracts.
at_list_contract_excluded_rolesFreeRead-onlyList roles excluded from a contract exclusion set.
at_list_contract_excluded_work_typesFreeRead-onlyList work types excluded from a contract exclusion set.
at_list_contract_exclusion_setsFreeRead-onlyList contract exclusion sets with optional filters.
at_list_contract_role_costsFreeRead-onlyList role cost overrides for contracts.
at_list_contract_service_adjustmentsFreeRead-onlyList service adjustments on contracts.
at_list_contract_service_bundle_unitsFreeRead-onlyList service bundle units on contracts.
at_list_contract_service_unitsFreeRead-onlyList service units on contracts.
at_list_contract_ticket_purchasesFreeRead-onlyList ticket purchases on contracts.
at_list_subscription_periodsFreeRead-onlyList subscription periods with optional filters.
at_update_contract_exclusion_setProDestructiveUpdate an existing contract exclusion set.

[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.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the exclusion set to create. Example: {"contractID":12345,"name":"Standard Exclusions"}.

[Autotask] Create a new service adjustment on a contract. Returns the created adjustment with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the service adjustment to create.

[Autotask] Create a new ticket purchase on a contract. Returns the created purchase with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the ticket purchase to create.

[Autotask] Delete a contract exclusion set by ID. Returns a confirmation response. This permanently removes the exclusion set.

ParamTypeRequiredDefaultDescription
exclusionSetIdintegeryesThe Autotask exclusion set ID to delete.

[Autotask] List billing item approval levels. Returns approval level details including level, approver, and status.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List roles excluded from a contract exclusion set. Returns details about which roles are excluded from billing under the contract.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List work types excluded from a contract exclusion set. Returns details about which work types are excluded from billing under the contract.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[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.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List service adjustments on contracts. Returns adjustment details including service, adjustment amount, and effective dates.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List service bundle units on contracts. Returns bundle unit details including bundle, quantity, and period.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List service units on contracts. Returns unit details including service, quantity, and period.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List ticket purchases on contracts. Returns purchase details including quantity, amount, and effective dates.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List subscription periods with optional filters. Returns period details including start/end dates, amount, and status.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing contract exclusion set. Returns the updated exclusion set. The JSON must include the id field.

ParamTypeRequiredDefaultDescription
exclusionSetIdintegeryesThe Autotask exclusion set ID to update.
fieldsJsonstringyesJSON object with fields to update. Example: {"name":"Updated Exclusions"}.

Invoice Extended

ToolPlanAccessSummary
at_get_company_invoice_settingsFreeRead-onlyRetrieve invoice settings for a specific company.
at_get_invoice_htmlFreeRead-onlyRetrieve the rendered HTML markup for an invoice.
at_get_invoice_pdfFreeRead-onlyRetrieve the PDF content for an invoice.
at_get_invoice_xmlFreeRead-onlyRetrieve the rendered XML markup for an invoice.
at_list_additional_invoice_field_valuesFreeRead-onlyList additional invoice field values with optional filters.
at_list_invoice_templatesFreeRead-onlyList available invoice templates.
at_list_quote_itemsFreeRead-onlyList quote line items with optional filters.
at_list_quote_locationsFreeRead-onlyList quote locations with optional filters.
at_list_quote_templatesFreeRead-onlyList available quote templates.
at_update_billing_itemProDestructiveUpdate an existing billing item via PATCH.
at_update_company_invoice_settingsProDestructiveUpdate invoice settings for a specific company via PUT.
at_update_invoiceProDestructiveUpdate an existing invoice via PUT.

[Autotask] Retrieve invoice settings for a specific company. Returns invoice configuration including template, payment terms, and delivery preferences.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID.

[Autotask] Retrieve the rendered HTML markup for an invoice. Returns the invoice content formatted as HTML.

ParamTypeRequiredDefaultDescription
invoiceIdintegeryesThe Autotask invoice ID.

[Autotask] Retrieve the PDF content for an invoice. Returns the invoice as a PDF document (may be base64-encoded).

ParamTypeRequiredDefaultDescription
invoiceIdintegeryesThe Autotask invoice ID.

[Autotask] Retrieve the rendered XML markup for an invoice. Returns the invoice content formatted as XML.

ParamTypeRequiredDefaultDescription
invoiceIdintegeryesThe Autotask invoice ID.

[Autotask] List additional invoice field values with optional filters. Returns custom field values associated with invoices.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List available invoice templates. Returns template details including name and format.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List quote line items with optional filters. Returns item details including product, quantity, unit price, and total.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List quote locations with optional filters. Returns location details associated with quotes.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List available quote templates. Returns template details including name and format.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing billing item via PATCH. Returns the updated billing item.

ParamTypeRequiredDefaultDescription
billingItemIdintegeryesThe Autotask billing item ID to update.
fieldsJsonstringyesJSON object with fields to update. Field names must match Autotask API field names.

[Autotask] Update invoice settings for a specific company via PUT. Returns the updated settings.

ParamTypeRequiredDefaultDescription
companyIdintegeryesThe Autotask company ID.
fieldsJsonstringyesJSON object with settings to update. Example: {"paymentTermID":2,"invoiceTemplateID":5}.

[Autotask] Update an existing invoice via PUT. Provide the invoice ID and a JSON object of fields to update. Returns the updated invoice.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update. Field names must match Autotask API field names.
invoiceIdintegeryesThe Autotask invoice ID to update.

Inventory

ToolPlanAccessSummary
at_add_inventory_stockProWriteAdd stock to an inventory product.
at_create_inventory_locationProWriteCreate a new inventory location.
at_create_purchase_order_itemProDestructiveCreate a new line item on a purchase order.
at_get_inventory_itemFreeRead-onlyRetrieve full details for a single inventory item by ID.
at_list_inventory_itemsFreeRead-onlyList inventory items with optional filters.
at_list_inventory_locationsFreeRead-onlyList inventory locations (warehouses, stock rooms).
at_list_inventory_productsFreeRead-onlyList inventory products with optional filters.
at_list_inventory_serial_numbersFreeRead-onlyList inventory item serial numbers with optional filters.
at_list_inventory_stocked_itemsFreeRead-onlyList stocked items in inventory.
at_list_inventory_transfersFreeRead-onlyList inventory transfers with optional filters.
at_list_product_notesFreeRead-onlyList notes associated with products.
at_list_product_tiersFreeRead-onlyList product pricing tiers.
at_list_product_vendorsFreeRead-onlyList product-vendor associations.
at_list_purchase_approvalsFreeRead-onlyList purchase approvals with optional filters.
at_list_purchase_order_itemsFreeRead-onlyList purchase order line items with optional filters.
at_remove_inventory_stockProDestructiveRemove stock from an inventory product.
at_transfer_inventory_stockProDestructiveTransfer stock between inventory locations.
at_update_purchase_order_itemProDestructiveUpdate an existing purchase order line item.

[Autotask] Add stock to an inventory product. Posts to the StockedItemsAdd child endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with stock details.
productIdintegeryesThe Autotask inventory product ID to add stock to.

[Autotask] Create a new inventory location. Returns the created location with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the location to create.

[Autotask] Create a new line item on a purchase order. Returns the created item with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the PO item to create.
ParamTypeRequiredDefaultDescription
inventoryItemIdintegeryesThe Autotask inventory item ID.

[Autotask] List inventory items with optional filters. Returns item details including product, location, quantity, and serial number.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List notes associated with products. Returns note details including title, description, and creation date.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List product pricing tiers. Returns tier details including quantity ranges and unit prices.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List product-vendor associations. Returns vendor details for each product.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Remove stock from an inventory product. Posts to the StockedItemsRemove child endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with removal details.
productIdintegeryesThe Autotask inventory product ID to remove stock from.

[Autotask] Transfer stock between inventory locations. Posts to the StockedItemsTransfer child endpoint.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with transfer details.
productIdintegeryesThe Autotask inventory product ID to transfer stock for.

[Autotask] Update an existing purchase order line item. Returns the updated item.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update.
itemIdintegeryesThe Autotask purchase order item ID to update.

Tags

ToolPlanAccessSummary
at_create_tagProWriteCreate a new tag.
at_create_tag_aliasProWriteCreate a new tag alias.
at_create_tag_groupProWriteCreate a new tag group.
at_delete_tagProDestructiveDelete a tag by ID.
at_get_tagFreeRead-onlyRetrieve full details for a single tag by ID.
at_list_tag_aliasesFreeRead-onlyList tag aliases with optional filters.
at_list_tag_groupsFreeRead-onlyList tag groups with optional filters.
at_list_tagsFreeRead-onlyList tags with optional filters.
at_update_tagProWriteUpdate an existing tag.
at_update_tag_groupProWriteUpdate an existing tag group.

[Autotask] Create a new tag. Returns the created tag with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the tag to create.

[Autotask] Create a new tag alias. Aliases provide alternative names for existing tags.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the tag alias to create.

[Autotask] Create a new tag group. Returns the created group with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the tag group to create.

[Autotask] Delete a tag by ID. This permanently removes the tag and any entity associations.

ParamTypeRequiredDefaultDescription
tagIdintegeryesThe Autotask tag ID to delete.
ParamTypeRequiredDefaultDescription
tagIdintegeryesThe Autotask tag ID.

[Autotask] List tag aliases with optional filters. Tag aliases allow alternative names for tags.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List tag groups with optional filters. Tag groups organize related tags.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List tags with optional filters. Tags are used to categorize and organize entities across Autotask.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing tag. Returns the updated tag.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update.
tagIdintegeryesThe Autotask tag ID to update.

[Autotask] Update an existing tag group. Returns the updated group.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update.
tagGroupIdintegeryesThe Autotask tag group ID to update.

Opportunity/Sales Sub-Resources

ToolPlanAccessSummary
at_list_opportunity_attachmentsFreeRead-onlyList attachments associated with opportunities.
at_list_opportunity_categoriesFreeRead-onlyList opportunity categories.
at_list_opportunity_sales_ordersFreeRead-onlyList sales orders associated with a specific opportunity.
at_list_sales_order_attachmentsFreeRead-onlyList attachments associated with sales orders.
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List opportunity categories. Returns category details including name and description.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
opportunityIdintegeryesThe Autotask opportunity ID to list sales orders for.
ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_get_internal_location_business_hoursFreeRead-onlyRetrieve business hours for internal locations.
at_get_roleFreeRead-onlyRetrieve full details for a single role by ID.
at_list_action_typesFreeRead-onlyList action types with optional filters.
at_list_classification_iconsFreeRead-onlyList classification icons with optional filters.
at_list_holiday_setsFreeRead-onlyList holiday sets with optional filters.
at_list_holidaysFreeRead-onlyList holidays with optional filters.
at_list_internal_locationsFreeRead-onlyList internal (office) locations with optional filters.
at_list_org_level_associationsFreeRead-onlyList organizational level associations.
at_list_organizational_level2sFreeRead-onlyList second-level organizational levels.
at_list_organizational_levelsFreeRead-onlyList top-level organizational levels (Level 1).
at_list_rolesFreeRead-onlyList roles with optional filters.
at_list_skillsFreeRead-onlyList skills with optional filters.

[Autotask] Retrieve business hours for internal locations. Returns schedule including days and time ranges.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).
ParamTypeRequiredDefaultDescription
roleIdintegeryesThe Autotask role ID.

[Autotask] List action types with optional filters. Action types categorize activities and time entries.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List classification icons with optional filters. Classification icons visually categorize companies and contacts.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List holiday sets with optional filters. Holiday sets define groups of holidays used for scheduling and SLA calculations.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List holidays with optional filters. Useful for reviewing scheduled holidays that affect SLA and business hour calculations.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List internal (office) locations with optional filters. Internal locations represent your company offices.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List organizational level associations. Returns associations linking resources or entities to organizational levels.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List second-level organizational levels. These are subdivisions within top-level organizational levels.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List top-level organizational levels (Level 1). Organizational levels define your company hierarchy.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List roles with optional filters. Roles define billing rates and are used for time entry and contract rate assignments.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List skills with optional filters. Skills are assigned to resources for competency tracking.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_list_countriesFreeRead-onlyList countries configured in Autotask.
at_list_currenciesFreeRead-onlyList currencies configured in Autotask.
at_list_domain_registrarsFreeRead-onlyList domain registrars configured in Autotask.
at_list_payment_termsFreeRead-onlyList payment terms configured in Autotask.
at_list_price_list_productsFreeRead-onlyList price list entries for products.
at_list_price_list_rolesFreeRead-onlyList price list entries for roles.
at_list_price_list_servicesFreeRead-onlyList price list entries for services.
at_list_shipping_typesFreeRead-onlyList shipping types configured in Autotask.
at_list_tax_categoriesFreeRead-onlyList tax categories configured in Autotask.
at_list_tax_regionsFreeRead-onlyList tax regions configured in Autotask.
at_list_taxesFreeRead-onlyList individual tax entries with optional filters.
at_list_work_type_modifiersFreeRead-onlyList work type modifiers with optional filters.

[Autotask] List countries configured in Autotask. Returns country details including name, ISO code, and active status.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List currencies configured in Autotask. Returns currency details including code, name, and exchange rate.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List domain registrars configured in Autotask. Useful for domain management tracking.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List payment terms configured in Autotask. Payment terms define invoice due date calculations (e.g., Net 30).

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List price list entries for products. Returns product pricing details.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List price list entries for roles. Returns role pricing details including hourly rate.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List price list entries for services. Returns service pricing details.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List shipping types configured in Autotask. Used when creating purchase orders and sales orders.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List tax categories configured in Autotask. Tax categories group products and services for tax calculation.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List tax regions configured in Autotask. Tax regions define geographic areas with specific tax rules.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List individual tax entries with optional filters. Returns tax details including name, rate, and region.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List work type modifiers with optional filters. Work type modifiers adjust billing rates (e.g., overtime).

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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

ToolPlanAccessSummary
at_create_udf_definitionProWriteCreate a new user-defined field definition.
at_list_deleted_task_activity_logsFreeRead-onlyList deleted task activity log entries with optional filters.
at_list_deleted_ticket_activity_logsFreeRead-onlyList deleted ticket activity log entries with optional filters.
at_list_deleted_ticket_logsFreeRead-onlyList deleted ticket log entries with optional filters.
at_list_integration_vendor_insightsFreeRead-onlyList integration vendor insights with optional filters.
at_list_integration_vendor_widgetsFreeRead-onlyList integration vendor widgets with optional filters.
at_list_notification_historyFreeRead-onlyList notification history with optional filters.
at_list_udf_definitionsFreeRead-onlyList user-defined field (UDF) definitions with optional filters.
at_list_udf_list_itemsFreeRead-onlyList picklist items for user-defined fields.
at_update_udf_definitionProDestructiveUpdate an existing user-defined field definition.

[Autotask] Create a new user-defined field definition. Returns the created UDF with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the UDF definition to create.

[Autotask] List deleted task activity log entries with optional filters. Useful for project audit trails.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List deleted ticket activity log entries with optional filters. Useful for audit trails.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List deleted ticket log entries with optional filters. Useful for audit trails and compliance.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List integration vendor insights with optional filters. Returns insight data from third-party integrations.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List integration vendor widgets with optional filters. Returns widget configuration data from integrations.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List notification history with optional filters. Useful for auditing email and alert delivery.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List user-defined field (UDF) definitions with optional filters. Returns UDF details including name, data type, and entity type.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List picklist items for user-defined fields. Returns item details including value, label, and sort order.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing user-defined field definition. Returns the updated UDF.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object with fields to update.
udfIdintegeryesThe Autotask UDF definition ID to update.

Expense Extended

ToolPlanAccessSummary
at_create_expense_itemProDestructiveCreate a new expense item.
at_list_expense_item_attachmentsFreeRead-onlyList attachments associated with expense items.
at_list_expense_report_attachmentsFreeRead-onlyList attachments associated with expense reports.
at_update_expense_itemProDestructiveUpdate an existing expense item.

[Autotask] Create a new expense item. Returns the created expense item with its assigned ID.

ParamTypeRequiredDefaultDescription
fieldsJsonstringyesJSON object for the expense item to create.

[Autotask] List attachments associated with expense items. Useful for reviewing receipts on line items.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] List attachments associated with expense reports. Useful for reviewing receipts.

ParamTypeRequiredDefaultDescription
filterJsonstringnonullJSON array of filter objects. Omit for no filtering.
maxRecordsintegerno500Maximum number of records to return (default 500, max 500).
nextPageUrlstringnonullPagination 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).

[Autotask] Update an existing expense item. Returns the updated expense item.

ParamTypeRequiredDefaultDescription
expenseItemIdintegeryesThe Autotask expense item ID to update.
fieldsJsonstringyesJSON object with fields to update.