Frontline PSA Docs

Administration

Autotask-compatible API

Frontline PSA answers the Autotask PSA REST API (v1.0). An RMM, documentation tool or script that already talks to Autotask can be pointed at Frontline PSA instead and keep working with the same requests. This page is for the administrator or integrator who sets that up.

You manage API access in Admin → API integrations.

Frontline PSA
The API integrations page with the New API user form, the API users table and Recent requests

Create an API user

Every request runs as a resource: that resource's security level decides what the integration may do, and its changes appear in the audit log under that resource's name.

  1. In Admin → Resources, add a dedicated resource for the integration (for example "RMM Integration") with only the security level it needs. See Administration.
  2. Go to Admin → API integrations. Under New API user, enter a Name for the integration and a UserName. The user name cannot contain spaces and is stored in lower case.
  3. Choose the resource in Acts as resource.
  4. Optionally tick Read-only to refuse every create, update and delete, or Allow ImpersonationResourceId to let the client act as another active resource by sending that header.
  5. Click Create.
  6. Copy the UserName, Secret, ApiIntegrationcode and Base URL from the panel that appears, then click I have stored them.

Note: The secret is shown once. If you lose it, click Rotate secret beside the API user to issue a new one; the old secret stops working.

The API users table shows each user's mode (read/write, read-only or disabled), request count and last use. Disable blocks a user without removing it and Enable restores it. You cannot delete an API user or change its options after creating it.

Connect the client

SettingValue
Base URLhttps://<your-host>/atservicesrest/v1.0
Zone discoveryGET https://<your-host>/atservicesrest/v1.0/zoneInformation?user=<name>

Zone discovery needs no credentials and returns your own host as the zone URL. A client that only asks Autotask's public servers for its zone needs the zone or base URL set by hand. The path and version are matched without regard to case, so /ATServicesRest/V1.0 also works.

Send three headers with every other request:

HeaderValue
UserNameThe API user's user name
SecretThe secret shown at creation
ApiIntegrationcodeThe integration code shown at creation

ImpersonationResourceId is accepted only when the API user allows it.

curl -X POST "https://<your-host>/atservicesrest/v1.0/Tickets/query" \
  -H "UserName: rmm@example.com" \
  -H "Secret: <secret>" \
  -H "ApiIntegrationcode: <code>" \
  -H "Content-Type: application/json" \
  -d '{"filter":[{"op":"eq","field":"status","value":1}]}'

Note: If your Frontline PSA sign-in is behind Cloudflare Access, the /atservicesrest/* path must be allowed through with a bypass or service-token policy. Integrations authenticate with the headers above, not through Access.

Supported entities

EntityReadWrite
TicketsYesCreate, update
TicketNotesYesCreate, update
TimeEntriesYesCreate, update, delete
CompaniesYesCreate, update
CompanyLocationsYesCreate, update
ContactsYesCreate, update
ConfigurationItemsYesCreate, update
TicketSecondaryResourcesYesCreate, delete
TicketAdditionalContactsYesCreate, delete
TicketAttachmentsYesCreate
AttachmentInfoYesNo
TicketHistoryYesNo
ServiceLevelAgreementResultsYesNo
Resources, ResourceRoles, RolesYesNo
BillingCodesYesNo
Contracts, Projects, TasksYesNo

Child collections work as in Autotask: Tickets/{id}/Notes, SecondaryResources, AdditionalContacts and Attachments; Companies/{id}/Contacts and Locations; Projects/{id}/Tasks.

Writes go through the same logic as the app, so ticket numbering, SLA clocks, workflow rules, billing locks and the audit log all apply. A write is refused with a 403 if the API user is read-only or its resource lacks the permission.

Queries and paging

Query with POST {Entity}/query and a JSON body, or GET {Entity}/query?search=<json>. {Entity}/query/count returns the count only, and GET {Entity}/{id} returns one item.

  • Operators: eq, noteq, gt, gte, lt, lte, beginsWith, endsWith, contains, exist, notExist, in, notIn, plus and/or groups with nested items.
  • Fields: names are not case-sensitive. A filter on an unknown field returns a 400. String comparisons ignore case.
  • Options: IncludeFields and MaxRecords are supported.
  • Paging: results are ordered by id and return at most 500 per page. When more remain, pageDetails.nextPageUrl holds the next page; follow it with GET or POST until it is null.
  • Errors: come back as { "errors": ["..."] } with the HTTP status. A missing required field reads Missing Required Field: <name>.

Field definitions and picklist values are available from {Entity}/entityInformation/fields.

Picklist integers

Autotask clients send integers for fields such as status and priority. Each Frontline PSA picklist value has a stable integer: Autotask's standard number where one exists, otherwise the next free number from 100.

FieldDefault values
Ticket statusNew 1, Complete 5, Waiting Customer 7, In Progress 8, Waiting Materials 9, Scheduled 10, Escalated 11, Customer Responded 19
PriorityHigh 1, Medium 2, Low 3, Critical 4
Ticket typeService Request 1, Incident 2, Problem 3, Change Request 4, Alert 5

You can see and change the integer for any value in the Autotask # column of Admin → Picklists. If a script uses a number from your old Autotask instance, for example a custom status, add the value in Picklists and set its Autotask # to match. Two values in the same list cannot share a number. An integer that matches no value is rejected with a 400 rather than filed under something else.

queueID values are Frontline PSA queue ids. On notes, publish 1 is customer-visible and 2 is internal.

Rate threshold

GET ThresholdInformation reports a threshold of 10,000 requests per hour and the current count across all API users, as Autotask does. Frontline PSA reports the figure but does not block requests that go over it.

Request log

Recent requests on the API integrations page lists the latest 100 calls: when, which integration, the method and path, the HTTP status, the time taken in milliseconds and any error. Failed calls are highlighted. Start here when a client reports a problem; a 401 means the headers are wrong or the user is disabled, and a 403 means read-only or a missing permission.

What is not supported

  • No webhooks and no SOAP. Autotask callouts and the older ATWS SOAP API are not available.
  • User-defined fields work on Tickets, Companies and ConfigurationItems only. Other entities return an empty list.
  • Unlisted entities return a 404 with the list of available ones.
  • Your own company keeps its Frontline PSA id. Autotask uses 0 for it.
  • Hard-coded record ids from Autotask (queues, resources, companies, contacts) do not carry over, because Frontline PSA assigns its own ids. Update those constants in your scripts before switching them over, or they will target the wrong record or none.
  • The integration code is required. The New API user form has no option to accept requests without ApiIntegrationcode.
  • Public notes do not send email. A customer-visible note created through the API is a public ticket note; nothing is emailed to the customer.