Which API to use

Which API to use

The Synergist API is divided into areas and each area is a standalone API.

For example:

  • Activities API
  • Jobs API
  • Calendar API

When using the Synergist API, usually one area is worked in at a time.
To create jobs, use the Jobs.json API which contains everything needed to create/modify jobs.

If listing clients prior to job creation, use the Jobs.json API not the Clients.json API.
The Jobs.json API is passed a parameter to indicate interest in listing clients.

Example (OAuth 2.0):

http://<SERVER>/jsonapi/***jobs.json?***company=1&***action=clients***&page=1&rows=10&version=6
Authorization: Bearer <access_token>

Example (legacy username/password):

http://<SERVER>/jsonapi/***jobs.json?***company=1&***action=clients***&page=1&rows=10&version=6&user=<username>&password=<password>