Skip to content
M Fairchild edited this page Apr 16, 2018 · 2 revisions

Rest API (Work in Progress)

The Rest API Classes are based on Jenssegers Model Class which is then based on Laravel's Eloquent Model. Some methods are

Available Methods

  • all()
  • count()
  • create($attributes)
  • delete()
  • find($id)
  • first()
  • get()
  • mock()
  • model()
  • sync($syncToken)
  • toArray()
  • toJson()
  • where($key, $value)
  • with($optionalProperties)

Example Usage

all()

$contacts = $infusionsoft()->contacts()->all();

count()

$count = $infusionsoft()->contacts()->count();

create($attributes)

$contact = $infusionsoft()->contacts()->create(['given_name' => 'Example', 'family_name' => 'Name']);

delete()

$contact->delete();

find($id)

$contact = $infusionsoft()->contacts()->find(1234);

first()

$contact = $infusionsoft()->contacts()->first();

$contact = $infusionsoft()->contacts()->where('family_name', 'Name')->first();

get()

$contacts = $infusionsoft()->contacts()->where('family_name','Name')->get();

mock()

$infusionsoft()->contacts()->mock(['id' => 123])->addTags([456,789]);

model()

$contacts = $infusionsoft()->contacts()->model();

sync()

$contacts = $infusionsoft()->contacts()->sync($token);

toArray()

$contacts = $infusionsoft()->contacts()->all()->toArray();

toJson()

$contacts = $infusionsoft()->contacts()->all()->toJson();

where()

$contacts = $infusionsoft()->contacts()->where('family_name', 'Name')->get();

with()

$contacts = $infusionsoft()->contacts()->with('custom_fields')->all();

$contacts = $infusionsoft()->contacts()->with(['custom_fields', 'social_accounts'])->all();