PHPackages                             anteris-dev/autotask-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. anteris-dev/autotask-client

ActiveLibrary

anteris-dev/autotask-client
===========================

This package provides a PHP API client for the Autotask REST API. It is strongly typed and it is a wonderful experience to work with these classes in any intelligent IDE with autocompletion.

v0.6.0(2y ago)2454.4k↓18.2%21[1 issues](https://github.com/Anteris-Dev/autotask-client/issues)[5 PRs](https://github.com/Anteris-Dev/autotask-client/pulls)1MITPHPPHP ^7.4 | ^8.0 | ^8.1

Since Aug 17Pushed 2y ago3 watchersCompare

[ Source](https://github.com/Anteris-Dev/autotask-client)[ Packagist](https://packagist.org/packages/anteris-dev/autotask-client)[ RSS](/packages/anteris-dev-autotask-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (10)Dependencies (8)Versions (20)Used By (1)

About this Package
==================

[](#about-this-package)

[![Test](https://github.com/Anteris-Dev/autotask-client/workflows/Test/badge.svg?branch=master)](https://github.com/Anteris-Dev/autotask-client/actions?query=workflow%3ATest)

This package provides a PHP API client for the Autotask REST API. It is strongly typed and it is a wonderful experience to work with these classes in any intelligent IDE with autocompletion.

To Install
----------

[](#to-install)

Run `composer require anteris-dev/autotask-client`

### Requirements

[](#requirements)

- **PHP ^7.4** so it can take full advantage of type casting in PHP.
- **Guzzle ^6.3** so it can make requests against the Autotask API.

Discord
-------

[](#discord)

Join the [Anteris-Dev Discord](https://discord.gg/JmYNRbg) to keep up with other users of this package!

Table of Contents
=================

[](#table-of-contents)

- [Getting Started](#getting-started)
    - [Client Wrapper](#client-wrapper)
    - [Bypassing the Client Wrapper](#bypassing-the-client-wrapper)
    - [Interacting with an Endpoint](#interacting-with-an-endpoint)
        - [create( $resource )](#create-resource-)
        - [deleteById( int $id )](#deletebyid-int-id-)
        - [findById( int $id )](#findbyid-int-id-)
        - [getEntityFields()](#getentityfields)
        - [getEntityInformation()](#getentityinformation)
        - [getEntityUserDefinedFields()](#getentityuserdefinedfields)
        - [query()](#query)
            - [where()](#where)
            - [orWhere()](#orwhere)
            - [records( int $records )](#records-int-records-)
            - [get()](#get)
            - [paginate()](#paginate)
            - [loop()](#loop)
        - [update()](#update-resource-)
- [Resources](#resources)

Getting Started
===============

[](#getting-started)

Client Wrapper
--------------

[](#client-wrapper)

For the purpose of ease, there is a client wrapper that allows you to easily interact with every Autotask service. This can be created as shown below.

```